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¶
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"