Contributing to co2mpas¶
If you want to contribute to CO2MPAS and improve it, your help is very welcome. Your contribution should be sent by a pull request. Next sections explains how to implement and submit a new functionality:
- clone the repository
- implement a new functionality
- open a pull request
Clone the repository¶
The first step to contribute to CO2MPAS is to clone the repository:
- Create a personal fork of the co2mpas repository on Github.
- Clone the fork on your local machine.
Your remote repo on Github is called
the original repository as a remote called
upstream, to maintain updated your fork.
- If you created your fork a while ago be sure to pull
upstreamchanges into your local repository.
- Create a new branch to work on! Branch from
How to implement a new functionality¶
Test cases are very important. This library uses a data-driven testing approach.
To implement a new function I recommend the test-driven development cycle. Hence, when you think that the code is ready,
add new test in
When all test cases are ok (
python setup.py test), open a pull request.
A pull request without new test case will not be taken into consideration.
How to open a pull request¶
Well done! Your contribution is ready to be submitted:
- Squash your commits into a single commit with git’s interactive rebase. Create a new branch if necessary. Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.
- Push your branch to
your fork on Github (i.e.,
git push origin dev).
- From your fork open a pull request in the correct branch.
Target the project’s
- Once the pull request is approved and merged you can pull the changes from
upstreamto your local repo and delete your extra branch(es).