Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/aluttik/gitready/issues.
If you are 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.
Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.
gitready could always use more documentation, whether as part of the official gitready docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/aluttik/gitready/issues.
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 contributions are welcome :)
Ready to contribute? Here's how to set up gitready for local development.
-
Fork the gitready repo on GitHub.
-
Clone your fork locally:
git clone [email protected]:your_name_here/gitready.git
-
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
-
When you're done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox:
tox
To get tox, just pip install it.
-
Before commiting your changes make sure that they comply with the code style guidelines by running black:
black
To get black, just pip install it.
-
Commit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
-
Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- Run
black
to make sure all the code is formatted correctly. - The pull request should work for CPython 2.7, 3.4, 3.5, 3.6, and 3.7. Check
https://travis-ci.org/aluttik/gitready under pull requests
for active pull requests or run the
tox
command and make sure that the tests pass for all supported Python versions.
To run a subset of tests:
tox -e <env> -- tests/<file>[::test]