Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Bug reports¶
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.
Documentation improvements¶
LASER Cholera could always use more documentation, whether as part of the official LASER Cholera docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue.
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 :)
Development setup¶
To set up laser-cholera for local development:
-
Fork laser-cholera (look for the "Fork" button).
-
Clone your fork locally:
git clone [email protected]:YOURGITHUBNAME/laser-cholera.git -
Create a branch for local development:
Now you can make your changes locally.
-
When you're done making changes, run all the checks and the docs builder with one command:
-
Commit your changes and push your branch to GitHub:
-
Submit a pull request through the GitHub website.
Pull-request guidelines¶
If you need some code review or feedback while you're developing the code, just open the pull request — early drafts are fine.
For a PR to be ready to merge it should:
- Include passing tests (run
tox). - Update documentation when there's new API, functionality, etc.
- Add a note to
CHANGELOG.mdabout the changes. - Add yourself to
AUTHORS.md.
Tips¶
To run a subset of tests:
To run all the test environments in parallel: