X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/3e3da8eef6f4ba48da1505ad68ca0e1d788f6d6b..a23f521fee1b283b10000d94267ef93069b7f7ec:/docs/contributing_to_black.md?ds=sidebyside diff --git a/docs/contributing_to_black.md b/docs/contributing_to_black.md index f0be872..562b43a 100644 --- a/docs/contributing_to_black.md +++ b/docs/contributing_to_black.md @@ -36,14 +36,40 @@ 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. -Before submitting pull requests, run lints and tests with: +Non pipenv install works too: ```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 -$ 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] ``` +### 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 @@ -54,7 +80,7 @@ your PR. You may need to change configuration for it to pass. For more `black-primer` information visit the -[documentation](https://github.com/psf/black/blob/master/docs/black_primer.md#). +[documentation](https://github.com/psf/black/blob/master/docs/black_primer.md). ## Hygiene