Skip to content

Commit c716a23

Browse files
robmoffatrobmoffat
committed
Added Finos Materials
1 parent 38d3285 commit c716a23

12 files changed

+398
-401
lines changed

‎.github/CODE_OF_CONDUCT.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Code of Conduct for Symphony Java Toolkit
2+
3+
Please see the [Community Code of Conduct](https://www.finos.org/code-of-conduct).

‎.github/CONTRIBUTING.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to Symphony Java Toolkit
2+
3+
## Contributor License Agreement (CLA)
4+
A CLA is a document that specifies how a project is allowed to use your
5+
contribution; they are commonly used in many open source projects.
6+
7+
**_All_ contributions to _all_ projects hosted by [FINOS](https://www.finos.org/)
8+
must be made with a
9+
[Foundation CLA](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/83034172/Contribute)
10+
in place, and there are [additional legal requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Legal+Requirements)
11+
that must also be met.**
12+
13+
Commits and pull requests to FINOS repositories such as Symphony Java Toolkit will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS ["CLA Bot" tool](https://github.com/finos/cla-bot). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
14+
15+
As a result, PRs submitted to the Symphony Java Toolkit project cannot be accepted until you have a CLA in place with the Foundation.
16+
17+
Need an ICLA? Unsure if you are covered under an existing CCLA? Email [[email protected]](mailto:[email protected]?subject=CLA)
18+
19+
## Contributing Issues
20+
21+
### Prerequisites
22+
23+
* [ ] Have you [searched for duplicates](https://github.com/finos/symphony-java-toolkit/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice.
24+
* [ ] Are you running the latest version?
25+
* [ ] Are you sure this is a bug or missing capability?
26+
27+
### Raising an Issue
28+
* Create your issue [here](https://github.com/finos/symphony-java-toolkit/issues/new).
29+
* New issues contain two templates in the description: bug report and enhancement request. Please pick the most appropriate for your issue, **then delete the other**.
30+
* Please also tag the new issue with either "Bug" or "Enhancement".
31+
* Please use [Markdown formatting](https://help.github.com/categories/writing-on-github/)
32+
liberally to assist in readability.
33+
* [Code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for exception stack traces and log entries, for example, massively improve readability.
34+
35+
## Contributing Pull Requests (Code & Docs)
36+
To make review of PRs easier, please:
37+
38+
* Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted.
39+
* For code contributions, follow the existing code layout.
40+
* For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/finos/symphony-java-toolkit/README.md).
41+
* Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too).
42+
* Reference issue #s if your PR has anything to do with an issue (even if it doesn't address it).
43+
* Minimise non-functional changes (e.g. whitespace).
44+
* Ensure all new files include a header comment block containing the [Apache License v2.0 and your copyright information](http://www.apache.org/licenses/LICENSE-2.0#apply).
45+
* If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/finos/symphony-java-toolkit/blob/master/NOTICE) with any new attribution or other notices
46+
47+
48+
### Commit and PR Messages
49+
50+
* **Reference issues, wiki pages, and pull requests liberally!**
51+
* Use the present tense ("Add feature" not "Added feature")
52+
* Use the imperative mood ("Move button left..." not "Moves button left...")
53+
* Limit the first line to 72 characters or less

‎.github/ISSUE_TEMPLATE/Bug_report.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: If something isn't working as expected 🤔.
4+
5+
---
6+
7+
## Bug Report
8+
9+
### Steps to Reproduce:
10+
1. ...step 1 description...
11+
2. ...step 2 description...
12+
3. ...step 3 description...
13+
14+
### Expected Result:
15+
...description of what you expected to see...
16+
17+
### Actual Result:
18+
...what actually happened, including full exceptions (please include the entire stack trace, including "caused by" entries), log entries, screen shots etc. where appropriate...
19+
20+
### Environment:
21+
...version and build of the project, OS and runtime versions, virtualised environment (if any), etc. ...
22+
23+
### Additional Context:
24+
...add any other context about the problem here. If applicable, add screenshots to help explain...

‎.github/ISSUE_TEMPLATE/Feature_request.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: I have a suggestion (and may want to implement it 🙂)!
4+
5+
---
6+
7+
## Feature Request
8+
9+
### Description of Problem:
10+
...what *problem* are you trying to solve that the project doesn't currently solve?
11+
12+
...please resist the temptation to describe your request in terms of a solution. Job Story form ("When [triggering condition], I want to [motivation/goal], so I can [outcome].") can help ensure you're expressing a problem statement.
13+
14+
### Potential Solutions:
15+
...clearly and concisely describe what you want to happen. Add any considered drawbacks.
16+
17+
... if you've considered alternatives, clearly and concisely describe those too.

‎.github/ISSUE_TEMPLATE/Support_question.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: 🤗 Support Question
3+
about: If you have a question about configuration, usage, etc. 💬
4+
5+
---
6+
7+
## Support Question
8+
9+
...ask your question here.
10+
11+
...be sure to search existing issues since someone might have already asked something similar.

‎.github/workflows/docusaurus.yml

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Docusaurus-website-build
2+
3+
# Only trigger on:
4+
# - master branch
5+
# - PR or Pull Request event types
6+
# - Docusaurus files: this file, docs/** and website/**
7+
on:
8+
push:
9+
branches:
10+
- master
11+
paths:
12+
- '.github/workflows/docusaurus.yml'
13+
- 'docs/**'
14+
- 'website/**'
15+
pull_request:
16+
paths:
17+
- '.github/workflows/docusaurus.yml'
18+
- 'docs/**'
19+
- 'website/**'
20+
21+
env:
22+
# Used by docusaurus publish-site command and comment-on-pr action
23+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24+
REPO_NAME: ${{ github.event.repository.name }}
25+
PATCH_SCRIPT_URL: https://raw.githubusercontent.com/finos/open-developer-platform/master/scripts/patch-docusaurus-config.sh
26+
CONTRIBUTE_SCRIPT_URL: https://raw.githubusercontent.com/finos/open-developer-platform/master/scripts/build-contribute-page.sh
27+
28+
jobs:
29+
website-build:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout repo
33+
uses: actions/checkout@v1
34+
- name: Install Node
35+
uses: actions/setup-node@v1
36+
- name: Install Website deps
37+
run: npm install --prefix website
38+
- name: Patch forked version
39+
run: |
40+
# Extract GitHub org/user and patch siteConfig.js only if not "finos"
41+
REPO="${{ github.repository }}"
42+
REPO_ORG=${REPO%"/"*}
43+
if [ "$REPO_ORG" != "finos" ]
44+
then echo "Repo organization is '$REPO_ORG', patching docusaurus configuration to work on a forked repo" ; curl ${{ env.PATCH_SCRIPT_URL }} | bash -s -- ${{ env.REPO_NAME }} $REPO_ORG
45+
else echo "Skipping patching, as this is the FINOS Organization"
46+
fi
47+
- name: Build Website
48+
run: |
49+
curl ${{ env.CONTRIBUTE_SCRIPT_URL }} | bash -s
50+
npm run build --prefix website
51+
- name: Publish Website
52+
run: |
53+
# Extract GitHub org/user
54+
REPO="${{ github.repository }}"
55+
GIT_USERNAME=${REPO%/*}
56+
# Set git user to finos-admin, if it's a push to a finos repo
57+
if [ "$GIT_USERNAME" == "finos" ] && [ "${{github.event_name }}" == "push" ]
58+
then GIT_USERNAME="finos-admin"
59+
elif [ "$GIT_USERNAME" == "finos" ] && [ "${{github.event_name }}" == "pull_request" ]
60+
then echo "Skipping publish, as this is a PR, not a Push event" ; exit 0
61+
fi
62+
# Configure git client
63+
echo "Publishing website for repo '${REPO}', using GitHub username '${GIT_USERNAME}' as author. Triggered by '${{github.event_name }}' event"
64+
git config --global user.email "[email protected]"
65+
git config --global user.name "$GIT_USERNAME"
66+
echo "machine github.com login $GIT_USERNAME password $GITHUB_TOKEN" > ~/.netrc
67+
# Run docusaurus-publish
68+
GIT_USER="finos-admin" npm run publish-gh-pages --prefix website
69+
- name: Create comment
70+
if: github.event_name == 'pull_request' && !contains(github.repository, 'finos/')
71+
uses: peter-evans/create-or-update-comment@v1
72+
with:
73+
token: ${{ secrets.GITHUB_TOKEN }}
74+
issue-number: ${{ github.event.number }}
75+
body: Website [preview is available](https://${{ github.actor }}.github.io/${{ env.REPO_NAME }})

‎CHANGES.md

+4
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,7 @@
4747
## 26th May 2020
4848

4949
- Improved tests and reliability of `symphony-shared-stream`
50+
51+
## 2nd September 2020
52+
53+
- Added FINOS materials.

0 commit comments

Comments
 (0)