if/SymphonyElectron
1
0
Fork 0
mirror of https://github.com/finos/SymphonyElectron.git synced 2024-12-26 08:51:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

aligning README.md and CONTRIBUTING.md to FINOS project blueprint language (#672)

Browse Source
This commit is contained in:
Nikolay Ganev 2019-06-04 14:26:19 +02:00 committed by Vishwas Shashidhar
parent 7a94ad31f8
commit 74a2d7fb37
4 changed files with 73 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,57 @@
# 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

23
CONTRIBUTING.md
View File

@ -1,23 +0,0 @@
# Contributing
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.
## Issue Process
1. Ensure that you fill up the issue template with appropriate details before creating the issue
2. Tag issues with appropriate labels for future usage
3. If issues are unanswered / not responded for more than 30 days, they'll be closed by the maintainers in which case you'll need to create a new issue and link it to the old issue.
4. Ensure you check if there are existing issues similar to what your issue is before creating a new one
## Pull Request Process
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Ensure unit & automation tests are run and corresponding proof documents are attached
3. Tag pull requests with appropriate labels for future usage
4. Tag / add reviewers you'd like to review in the PR
5. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.

4
NOTICE
View File

@ -1,2 +1,2 @@
SymphonyElectron
Copyright 2019 Symphony Software Foundation
SymphonyElectron - FINOS
Copyright 2019 Symphony LLC

14
README.md
View File

@ -6,6 +6,15 @@
SymphonyElectron is a desktop client of the Symphony Communication Platform built for macOS, Windows 10 and Windows 7. We've built this using the popular [electron](https://github.com/electron/electron) framework to support cross platform desktop apps loaded in a chromium container
## Contributing
1. Fork it (<https://github.com/symphonyoss/SymphonyElectron/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
4. Commit your changes (`git commit -am 'Add some fooBar'`)
5. Push to the branch (`git push origin feature/fooBar`)
6. Create a new Pull Request
## Project Goals:
Our goal is to improve the performance and development agility of Symphony's desktop wrapper and build a path to support other wrappers by:
@ -19,3 +28,8 @@ In order to achieve those goals Symphony is participating and working in close c
## Development Setup & Running
Read [Dev Setup](./DEV_SETUP.md)
## License
The code in this repository is distributed under the Apache License, Version 2.0.
Copyright 2019 Symphony LLC