We appreciate all contributions to gwf, not just contributions to the code! Think something is missing from the documentation? Defined useful snippets for your text editor? Add it and submit a pull request!
Set Up a Development Environment¶
We strongly recommend that you use the Anaconda Python distribution and the conda package manager to set up a development environment (actually, we recommend it for all of your Python work). However, feel free to use virtualenvs instead.
Download and install the Anaconda Python distribution following the instructions here.
Create an environment for gwf development:
conda create -n gwfdev python=3.5
Activate the environment:
source activate gwfdev
Make Your Changes¶
Fork the repository, clone it and create a branch for your changes:
git checkout -b my-change
Make the necessary changes and add unit tests if necessary.
Add a description of the changes to
CHANGELOG.rstand add yourself to
CONTRIBUTORS.rst(if you’re not already there).
Test your changes and check for style violations:
make init # to install gwf for development gwf ... # test your changes by running gwf make lint # to check for style issues make test # to run tests make coverage # to check test coverage
If everything is alright, commit your changes:
git add . git commit -m "Added some-feature"