requests_toolbelt Documentation, Release 1.0.0
2. Fork the repository on GitHub or GitLab
3. Create a new branch, e.g., git checkout -b bug/12345
4. Fix the bug and add tests (if applicable
1
, see How To Add Tests)
5. Run the tests (see How To Run The Tests below)
6. Add documentation (as necessary) for your change
7. Build the documentation to check for errors and formatting (see How To Build The Documentation below)
8. Add yourself to the AUTHORS.rst (unless you’re already there)
9. Commit it. Follow these rules in your commit message:
• Keep the subject line under 50 characters
• Use an imperative verb to start the commit
• Use an empty line between the subject and the message
• Describe the why in detail in the message portion of the commit
• Wrap the lines of the message at 72 characters
• Add the appropriate “Closes #12345” syntax to autoclose the issue it fixed (if it closes an issue)
• See Example Commit Message below
10. Push it to your fork
11. Create a request for us to merge your contribution
After this last step, it is possible that we may leave feedback in the form of review comments. When addressing these
comments, you can follow two strategies:
• Amend/rebase your changes into an existing commit
• Create a new commit with a different message
2
describing the changes in that commit and push it to your branch
This project is not opinionated about which approach you should prefer. We only ask that you are aware of the
following:
• Neither GitHub nor GitLab notifies us that you have pushed new changes. A friendly ping is encouraged
• If you continue to use the same branch that you created the request from, both GitHub and GitLab will update
the request on the website. You do not need to create a new request for the new changes.
1.2.2 Contributor Code of Conduct
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we
pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level
of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size,
race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
• The use of sexualized language or imagery
1
You might not need tests if you’re updating documentation, fixing a typo, or updating a docstring. If you’re fixing a bug, please add tests.
2
If each commit has the same message, the reviewer may ask you to squash your commits or may squash them for you and perform a manual
merge.
1.2. Contributing to this project 5