mirror of
https://github.com/finos/SymphonyElectron.git
synced 2024-12-27 01:11:13 -06:00
57 lines
3.9 KiB
Markdown
57 lines
3.9 KiB
Markdown
|
# Contributing to SymphonyElectron
|
||
|
|
|
||
|
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||
|
|
email, or any other method with the owners of this repository before making a change.
|
||
|
|
|
||
|
|
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||
|
|
|
||
|
|
# Contributor License Agreement (CLA)
|
||
|
|
A CLA is a document that specifies how a project is allowed to use your
|
||
|
|
contribution; they are commonly used in many open source projects.
|
||
|
|
|
||
|
|
**_All_ contributions to _all_ projects hosted by [FINOS](https://www.finos.org/)
|
||
|
|
must be made with a
|
||
|
|
[Foundation CLA](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/83034172/Contribute)
|
||
|
|
in place, and there are [additional legal requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Legal+Requirements)
|
||
|
|
that must also be met.**
|
||
|
|
|
||
|
|
_NOTE:_ Commits and pull requests to FINOS repositories 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 Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
|
||
|
|
|
||
|
|
As a result, PRs submitted to the SymphonyElectron project cannot be accepted until you have a CLA in place with the Foundation.
|
||
|
|
|
||
|
|
*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)*
|
||
|
|
|
||
|
|
# Contributing Issues
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
* [ ] Have you [searched for duplicates](https://github.com/symphonyoss/SymphonyElectron/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice.
|
||
|
|
* [ ] Are you running the latest version?
|
||
|
|
* [ ] Are you sure this is a bug or missing capability?
|
||
|
|
|
||
|
|
## Raising an Issue
|
||
|
|
* Create your issue [here](https://github.com/symphonyoss/SymphonyElectron/issues/new).
|
||
|
|
* 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**.
|
||
|
|
* Please also tag the new issue with either "Bug" or "Enhancement".
|
||
|
|
* Please use [Markdown formatting](https://help.github.com/categories/writing-on-github/)
|
||
|
|
liberally to assist in readability.
|
||
|
|
* [Code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for exception stack traces and log entries, for example, massively improve readability.
|
||
|
|
|
||
|
|
# Contributing Pull Requests (Code & Docs)
|
||
|
|
To make review of PRs easier, please:
|
||
|
|
|
||
|
|
* Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted.
|
||
|
|
* For code contributions, follow the existing code layout.
|
||
|
|
* For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/symphonyoss/SymphonyElectron/wiki).
|
||
|
|
* Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too).
|
||
|
|
* Reference issue #s if your PR has anything to do with an issue (even if it doesn't address it).
|
||
|
|
* Minimise non-functional changes (e.g. whitespace).
|
||
|
|
* 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).
|
||
|
|
* If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/symphonyoss/SymphonyElectron/blob/master/NOTICE) with any new attribution or other notices
|
||
|
|
|
||
|
|
## Commit and PR Messages
|
||
|
|
|
||
|
|
* **Reference issues, wiki pages, and pull requests liberally!**
|
||
|
|
* Use the present tense ("Add feature" not "Added feature")
|
||
|
|
* Use the imperative mood ("Move button left..." not "Moves button left...")
|
||
|
|
* Limit the first line to 72 characters or less
|