Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions
Report bugs at https://github.com/nbQA-dev/nbQA/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” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
nbqa could always use more documentation, whether as part of the official nbqa 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/nbQA-dev/nbQA/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
nbqa for local development.
nbqarepo on GitHub at https://github.com/nbQA-dev/nbQA.
Clone your fork locally:
$ git clone firstname.lastname@example.org:your_name_here/nbqa.git nbqa-dev $ cd nbqa-dev
Create a virtual environment for local development:
$ tox --devenv venv $ . venv/bin/activate
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 tests:
$ tox -e py
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.
Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
The pull request should work for Python 3.6, 3.7, 3.8, and 3.9.
Add yourself as a contributor
To add yourself to the table of contributors, please follow the bot usage instructions.
Example of comment:
@all-contributors please add @<username> for documentation
It’s considered a good practice to always prefix usernames with
Enable pre-commit to catch errors early-on: