s_ranjbar/energy_system_modelling_workflow
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'CONTRIBUTING.md'

Browse Source 
check grammar and typo correction
This commit is contained in:
Guille 2020-06-09 08:41:27 -04:00
parent b0cdef2ea2
commit bfd8c10bff
1 changed files with 23 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
CONTRIBUTING.md
View File

@ -15,36 +15,32 @@ Before sending your pull requests, make sure you followed this list.
### 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.
CERC Libs is an [LGPL licensed](LICENSE.md) software, so even if we'd love to accept your patches, Before we can take them, please be sure that you are the intellectual 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.
***NOTE***: Only source code that you own will go 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)
If you have improvements to CERC Libs or 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 merge your changes on CERC Libs, and your code will become an integral part of Insel4D platform.
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.
If you prefer to contribute, instead of adding new functionality, you can also take a look at 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.
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.
* Include unit tests when you contribute new features, as they help to:
..1. prove that your code works correctly.
..2. 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:
.
..1. Clearly indicate which features are affected by your changes.
..2. Technical reasons for the changes.
* Tests should follow the
[testing best practices](CONTRIBUTING.md#user-content-testing-best-practices)
guide.
@ -52,7 +48,7 @@ if you need to broke the backward compatibility please ensure that you:.
#### License
At the top of any new file a small header with author contact information and the license information should be included.
Include a small header with contact information and the code license at the top of any new file like in the following example.
"""
Name module
@ -63,10 +59,10 @@ At the top of any new file a small header with author contact information and th
#### Coding style
Changes to CERC Libs python code should conform to our coding style
[Cerc Python Style Guide](PYGUIDE.md)
Changes to CERC Libs python code should conform to our coding style [Cerc Python Style Guide](PYGUIDE.md)
But as a general basis all contributions need to be focus in the concept of code clarity and use `pylint` to check your Python changes.
As a general basis, all contributions need to be focused on the concept of code clarity and use pylint to check your Python changes.
To install pylint and check your files against Cerc custom style definition:
To install `pylint` and check a file
with `pylint` against Cerc custom style definition:
@ -78,12 +74,12 @@ pylint --rcfile=pylintrc myfile.py
#### 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.
Before any pull request, the code must been manually and automatically tested to ensure at least some quality minimum. There are a few practices for unit tests that we believe are important, so we encourage 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.
* The test should be self-contained, which implies that your tests will prepare and clean up everything before and after the test execution.
* We encourage you to create if possible functional tests that cover the complete workflow of the implemented functionality.
* Maximize your code coverage by ensuring that you are testing as much of your code as possible.
#### 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.
In case of new functionality, a general overview, configuration, installation, and user manuals need to be provided by the developer; this will provide an excellent starting point for all the future users and help you detect any inconsistencies in your design.