90 lines
4.1 KiB
Markdown
90 lines
4.1 KiB
Markdown
# Contributing guidelines
|
|
|
|
## Push Request Checklist
|
|
|
|
Before sending your pull requests, make sure you followed this list.
|
|
|
|
- Read [contributing guidelines](CONTRIBUTING.md).
|
|
- Read [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
- Check if my changes are consistent with the [guidelines](CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution).
|
|
- Changes are consistent with the [Coding Style](CONTRIBUTING.md#coding-style).
|
|
- Manually test your code and add [Unit Tests](CONTRIBUTING.md#testing_best_practices).
|
|
- [Document your work](CONTRIBUTING.md#documentation).
|
|
|
|
## How to become a contributor and submit your own code
|
|
|
|
### Contributor License Agreements
|
|
|
|
CERC Libs is released under [LGPL license](LICENSE.md) so even if we'd love to accept your patches, Before we can take them, please be sure that you are the intelectual property owner of your code and that do you fully understand and respect our software license.
|
|
|
|
***NOTE***: Only original source code from you can be accepted into the main repository.
|
|
|
|
### Contributing code
|
|
|
|
If you have improvements to CERC Libs, or you want to extend the functionality, please send us your pull request as seen at [git pull request documentation](https://git-scm.com/docs/git-request-pull)
|
|
|
|
|
|
Once the pull requests are approved and pass continuous integration checks, a team member will apply `ready to pull` label to your change and your pull request will be merged on CERC Libs and become an integral part of Insel4D platform.
|
|
|
|
If you prefer to contribute, instead to add a new functionality you can also take a look into our ticket system and try to fix any of the listed issues.
|
|
|
|
### Contribution guidelines and standards
|
|
|
|
Before sending your pull request for review,
|
|
make sure your changes are consistent with the guidelines and follow the
|
|
CERC Libs coding style.
|
|
|
|
#### General guidelines and philosophy for contribution
|
|
|
|
* Include unit tests when you contribute new features, as they help to a)
|
|
prove that your code works correctly, and b) guard against future breaking
|
|
changes to lower the maintenance cost.
|
|
* Bug fixes also generally require unit tests, because the presence of bugs
|
|
usually indicates insufficient test coverage.
|
|
* Keep backward compatibility in mind when you change code in CERC Libs and
|
|
if you need to broke the backward compatibility please ensure that you:.
|
|
..* Clearly indicate which features are affected by your changes.
|
|
..* Technical reasons for the changes.
|
|
* Tests should follow the
|
|
[testing best practices](CONTRIBUTING.md#testing_best_practices)
|
|
guide.
|
|
* [Document your contribution](CONTRIBUTING.md#documentation)
|
|
|
|
#### License
|
|
|
|
At the top of any new file a small header with author contact information and the license information should be included.
|
|
|
|
"""
|
|
Name module
|
|
SPDX - License - Identifier: LGPL - 3.0 - or -later
|
|
Copyright © 2020 Project Author name mail@concordia.ca
|
|
"""
|
|
|
|
|
|
#### Python coding style
|
|
|
|
Changes to CERC Libs python code should conform to our coding style
|
|
[Cerc Python Style Guide](PYGUIDE.md)
|
|
|
|
Use `pylint` to check your Python changes. To install `pylint` and check a file
|
|
with `pylint` against Cerc custom style definition:
|
|
|
|
```bash
|
|
pip install pylint
|
|
pylint --rcfile=pylintrc myfile.py
|
|
```
|
|
|
|
<a name="testing_best_practices"></a>
|
|
#### Testing best practices
|
|
|
|
Prior to any pull request is expected that the code is both, manualy and automatically tested, to ensure at least some quality minimum, there are a few practices for unittest that we believe are important, so we encorage you to follow it.
|
|
|
|
* Test should be self contained, that implies that test preparation and cleaning up is performed at the before and after the test execution.
|
|
* We encorage you to create if possible functional tests that cover the complete workflow of the implemented functionality
|
|
* Maximize your code coverage by ensure that you are testing as much of your code as possible.
|
|
|
|
<a name="documentation"></a>
|
|
#### Documentation
|
|
|
|
In case of new functionality a general overview, configuration, instalation and usage manuals need to be provided by the developer, this will not only provide a nice starting point for all the future users but help you to detect any inconsistences in your design.
|