Bug reports, feature suggestions and other contributions are greatly appreciated! While I can’t promise to implement everything, I will always try to respond in a timely manner.
You can also contribute by testing pull request or performing code reviews. If
you help out in ways that don’t involve hacking the code, please add your name
under the Thanks header in the
AUTHORS.rst file. We appreciate the
time you have given to improve this project.
- Submit bug reports and feature requests at GitHub
- Make pull requests to the
When reporting a bug please include:
- Your operating system name and version
- Any details about your local setup that might be helpful in troubleshooting
- Detailed steps to reproduce the bug
Feature requests and feedback¶
The best way to send feedback is to file an issue at GitHub.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that code contributions are welcome :)
To set up aacgmv2 for local development:
Clone your fork locally:
git clone email@example.com:your_name_here/aacgmv2.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally. Add tests for bugs and new features in
tests/test_py_aacgmv2.py(for the wrapper),
test_c_aacgmv2.py(for the C extension), or
tests/test_cmd_aacgmv2.py(for the command-line interface).
tests/test_dep_aacgmv2.pyincludes tests for deprecated functions. The tests are run with
py.testand can be written as normal functions (starting with
test_) containing a standard
assertstatement for testing output, or use the numpy testing suite.
Commit your changes and push your branch to GitHub:
git add . git commit -m "Brief description of your changes" git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website. Pull requests should be made to the
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code, just make a pull request.
For merging, you should:
- Include passing tests (run
- Update/add documentation if relevant
- Add a note to
CHANGELOG.rstabout the changes
- Add yourself to
|||(1, 2) If you don’t have all the necessary Python versions available locally or have trouble building all the testing environments, you can rely on Travis and AppVeyor - they will run the tests for each change you add in the pull request.|
To run a subset of tests:
tox -e envname -- py.test -k test_myfeature
To run all the test environments in parallel (you need to
pip install detox):