How To Contribute¶
First off, thank you for considering contributing to
It’s people like you who make it is such a great tool for everyone.
Here are a few guidelines to get you started (but don’t be afraid to open half-finished PRs and ask questions if something is unclear!):
- No contribution is too small! Please submit as many fixes for typos and grammar bloopers as you can!
- Try to limit each pull request to one change only.
- Always add tests and docs for your code. This is a hard rule; patches with missing tests or documentation can’t be accepted.
- Make sure your changes pass our CI. You won’t get any feedback until it’s green unless you ask for it.
- Once you’ve addressed review feedback, make sure to bump the pull request with a short note. Maintainers don’t receive notifications when you push new commits.
- Don’t break backward compatibility.
def func(x): """ Does something. :param str x: A very important parameter. :rtype: str """
If you add or change public APIs, tag the docstring using
.. versionadded:: 16.0.0 WHATor
.. versionchanged:: 16.2.0 WHAT.
Prefer double quotes (
") over single quotes (
') unless the string contains double quotes itself.
Write your asserts as
expected == actualto line them up nicely:
x = f() assert 42 == x.some_attribute assert "foo" == x._a_private_attribute
To run the test suite, all you need is a recent tox. It will ensure the test suite runs with all dependencies against all Python versions just as it will on Travis CI. If you lack some Python versions, you can can always limit the environments like
tox -e py27,py35(in that case you may want to look into pyenv, which makes it very easy to install many different Python versions in parallel).
Write good test docstrings.
To ensure new features work well with the rest of the system, they should be also added to our Hypothesis testing strategy which you find in
This is a sentence. This is another sentence.
If you add a new feature, demonstrate its awesomeness in the examples page!
- Add awesome new feature. The feature really *is* awesome. [`#1 <https://github.com/hynek/attrs/pull/1>`_] - Fix nasty bug. The bug really *was* nasty. [`#2 <https://github.com/hynek/attrs/pull/2>`_]
Again, this list is mainly to help you to get started by codifying tribal knowledge and expectations. If something is unclear, feel free to ask for help!
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please report any harm to Hynek Schlawack in any way you find appropriate.
Thank you for considering contributing to
Contributor Covenant Code of Conduct¶
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at email@example.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.