Rooba
/
attrs
mirror of https://github.com/python-attrs/attrs.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor docs polish

This commit is contained in:
Hynek Schlawack 2022-08-23 10:12:44 +02:00
parent d4f33d9654
commit 20453b1a61
No known key found for this signature in database
GPG Key ID: AE2536227F69F181
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/CONTRIBUTING.md vendored
View File

@ -1,6 +1,6 @@
# How To Contribute
First off, thank you for considering contributing to `attrs`!
Thank you for considering contributing to `attrs`!
It's people like *you* who make it such a great tool for everyone.
This document intends to make contribution more accessible by codifying tribal knowledge and expectations.
@ -24,10 +24,10 @@ The official tag is `python-attrs` and helping out in support frees us up to imp
- 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.
- Since we squash on merge, it's up to you how you handle updates to the main branch.
Whether you prefer to rebase on main or merge main into your branch, do whatever is more comfortable for you.
- Since we squash on merge, it's up to you how you handle updates to the `main` branch.
Whether you prefer to rebase on `main` or merge `main` into your branch, do whatever is more comfortable for you.
- *Always* add tests and docs for your code.
This is a hard rule; patches with missing tests or documentation can't be merged.
This is a hard rule; patches with missing tests or documentation won't be merged.
- Make sure your changes pass our [CI].
You won't get any feedback until it's green unless you ask for it.
- For the CI to pass, the coverage must be 100%.
@ -84,6 +84,8 @@ $ make html
The built documentation can then be found in `docs/_build/html/`.
---
To avoid committing code that violates our style guide, we strongly advise you to install [*pre-commit*] and its hooks:
```console

2
AUTHORS.rst
View File

@ -3,7 +3,7 @@ Credits
``attrs`` is written and maintained by `Hynek Schlawack <https://hynek.me/>`_.
The development is kindly supported by `Variomedia AG <https://www.variomedia.de/>`_, ``attrs`` `Tidelift subscribers <https://tidelift.com/subscription/pkg/pypi-attrs?utm_source=pypi-attrs&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_, and all my amazing `GitHub Sponsors <https://github.com/sponsors/hynek>`_.
The development is kindly supported by my employer `Variomedia AG <https://www.variomedia.de/>`_, ``attrs`` `Tidelift subscribers <https://tidelift.com/subscription/pkg/pypi-attrs?utm_source=pypi-attrs&utm_medium=referral&utm_campaign=enterprise&utm_term=repo>`_, and all my amazing `GitHub Sponsors <https://github.com/sponsors/hynek>`_.
A full list of contributors can be found in `GitHub's overview <https://github.com/python-attrs/attrs/graphs/contributors>`_.