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¶
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.
Django REST framework reCAPTCHA could always use more documentation, whether as part of the official Django REST framework reCAPTCHA 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/Maximilien-R/django-rest-framework-recaptcha/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? The easiest way to work on
djangorestframework-recaptcha for local development is to use Docker.
djangorestframework-recaptcha come with a
Dockerfile and a
that implements all the needed stuff and helpers to work on this project.
$ git clone firstname.lastname@example.org:your_name_here/django-rest-framework-recaptcha.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 format check, flake8, complexity and the tests, including testing other Python versions with tox:
$ make check-format $ make style $ make complexity $ make test-all
- Format your code and then commit your changes and push your branch to GitHub:
$ make format $ 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.
- The pull request should work for Python 2.7, 3.4, 3.5, 3.6 and 3.7, and for PyPy. Check https://travis-ci.org/Maximilien-R/django-rest-framework-recaptcha/pull_requests and make sure that the tests pass for all supported Python versions.
- Your code need to be formatted. On this project we use the
black code formatter. You can easily
format your code with this command:
A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in
HISTORY.rst). Then run:
$ make bumpversion -e VERSION_PART=patch # options: major / minor / patch $ git push $ git push --tags
Travis will then deploy to PyPI if tests pass.
You can also participate in the project by adding new language or improving translations.
To add a new language:
$ make build-translations -e LOCALE=en
To update available languages and check for new strings:
$ make update-translations
To compile translations:
$ make compile-translations