diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 76bbe824..4b5c162f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 diff --git a/AUTHORS.rst b/AUTHORS.rst index d0ac4592..6f9fde94 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -3,7 +3,7 @@ Credits ``attrs`` is written and maintained by `Hynek Schlawack `_. -The development is kindly supported by `Variomedia AG `_, ``attrs`` `Tidelift subscribers `_, and all my amazing `GitHub Sponsors `_. +The development is kindly supported by my employer `Variomedia AG `_, ``attrs`` `Tidelift subscribers `_, and all my amazing `GitHub Sponsors `_. A full list of contributors can be found in `GitHub's overview `_.