X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/28547942498bbac24ba4165800382ae9b170c788..180bc06ede96959fd52b43467ce3836655108719:/CONTRIBUTING.md?ds=inline diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 596ce73..f674224 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,17 @@ # Contributing to Black Welcome! Happy to see you willing to make the project better. Have you -read the entire [README](README.md) yet? +read the entire [user documentation](http://black.readthedocs.io/en/latest/) +yet? ## Bird's eye view -In terms of inspiration, *Black* is about as configurable as *gofmt* and -*rustfmt* are. This is deliberate. +In terms of inspiration, *Black* is about as configurable as *gofmt*. +This is deliberate. Bug reports and fixes are always welcome! Please follow the issue -template for best results. +template on GitHub for best results. Before you suggest a new feature or configuration knob, ask yourself why you want it. If it enables better integration with some workflow, fixes @@ -29,6 +30,7 @@ myself and CentOS at work. Install all development dependencies using: ``` $ pipenv install --dev +$ pre-commit install ``` If you haven't used `pipenv` before but are comfortable with virtualenvs, just run `pip install pipenv` in the virtualenv you're already using and @@ -40,10 +42,6 @@ Before submitting pull requests, run tests with: $ python setup.py test ``` -Also run mypy and flake8 on `black.py` and `test_black.py`. Travis will -run all that for you but if you left any errors here, it will be quicker -and less embarrassing to fix them locally ;-) - ## Hygiene