X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/f8e9544c930a1469bee8b3f131687e2cae52e59b..6aef6c9d458e8df88f510e94c18f216232b6a786:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7008ecb..be7c505 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,18 @@ -# Contributing to Black +# Contributing to *Black* Welcome! Happy to see you willing to make the project better. Have you -read the entire [user documentation](http://black.readthedocs.io/en/latest/) +read the entire [user documentation](https://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 on GitHub for best results. +Bug reports and fixes are always welcome! Please follow the [issue +template on GitHub](https://github.com/psf/black/issues/new) 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 @@ -24,17 +25,18 @@ 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.6.4. You can use any operating system. I am using macOS +writing it's 3.7 You can use any operating system. I am using macOS myself and CentOS at work. Install all development dependencies using: ``` $ pipenv install --dev +$ pipenv shell $ 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 -invoke the command above from the cloned Black repo. It will do the +invoke the command above from the cloned *Black* repo. It will do the correct thing. Before submitting pull requests, run tests with: