fix typing issue around lru_cache arguments (#2098)

[etc/vim.git] / docs / contributing_to_black.md

diff --git a/docs/contributing_to_black.md b/docs/contributing_to_black.md
index e5307adb5d04aa537a45e1bc5e9e02e4217266db..b911b465afd352aae1942e849a127911a6401b8d 100644 (file)
--- a/docs/contributing_to_black.md
+++ b/docs/contributing_to_black.md
@@ -21,7 +21,7 @@ unlikely to get accepted. You can still try but prepare to be disappointed.
 
 ## Technicalities
 
 
 ## Technicalities
 

-Development on the latest version of Python is preferred. As of this writing it's 3.8.
+Development on the latest version of Python is preferred. As of this writing it's 3.9.

 You can use any operating system. I am using macOS myself and CentOS at work.
 
 Install all development dependencies using:
 You can use any operating system. I am using macOS myself and CentOS at work.
 
 Install all development dependencies using:


@@ -36,14 +36,56 @@ If you haven't used `pipenv` before but are comfortable with virtualenvs, just r
 `pip install pipenv` in the virtualenv you're already using and invoke the command above
 from the cloned _Black_ repo. It will do the correct thing.
 
 `pip install pipenv` in the virtualenv you're already using and invoke the command above
 from the cloned _Black_ repo. It will do the correct thing.
 

-Before submitting pull requests, run lints and tests with:
+Non pipenv install works too:

 
 ```console
 
 ```console

+$ pip install -r test_requirements
+$ pip install -e .[d]
+```
+
+Before submitting pull requests, run lints and tests with the following commands from
+the root of the black repo:
+
+```console
+# Linting

 $ pre-commit run -a
 $ pre-commit run -a

-$ python -m unittest
+
+# Unit tests
+$ tox -e py
+
+# Optional Fuzz testing
+$ tox -e fuzz
+
+# Optional CI run to test your changes on many popular python projects

 $ black-primer [-k -w /tmp/black_test_repos]
 ```
 
 $ black-primer [-k -w /tmp/black_test_repos]
 ```
 

+### News / Changelog Requirement
+
+`Black` has CI that will check for an entry corresponding to your PR in `CHANGES.md`. If
+you feel this PR not require a changelog entry please state that in a comment and a
+maintainer can add a `skip news` label to make the CI pass. Otherwise, please ensure you
+have a line in the following format:
+
+```md
+- `Black` is now more awesome (#X)
+```
+
+To workout X, please use
+[Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This
+is not perfect but saves a lot of release overhead as now the releaser does not need to
+go back and workout what to add to the `CHANGES.md` for each release.
+
+### Docs Testing
+
+If you make changes to docs, you can test they still build locally too.
+
+```console
+$ pip install -r docs/requirements.txt
+$ pip install [-e] .[d]
+$ sphinx-build -a -b html -W docs/ docs/_build/
+```
+

 ## black-primer
 
 `black-primer` is used by CI to pull down well-known _Black_ formatted projects and see
 ## black-primer
 
 `black-primer` is used by CI to pull down well-known _Black_ formatted projects and see