X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/205f3b67fbddc7ba0fa330c0493821e404451b82..caa3fcc2de3cfb6162bee0bb6f68b10bc38e612f:/docs/contributing_to_black.md diff --git a/docs/contributing_to_black.md b/docs/contributing_to_black.md index e5307ad..562b43a 100644 --- 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 -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: @@ -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