CONTRIBUTING.md

   1 # Contributing to _Black_
   2
   3 Welcome! Happy to see you willing to make the project better. Have you read the entire
   4 [user documentation](https://black.readthedocs.io/en/latest/) yet?
   5
   6 ## Bird's eye view
   7
   8 In terms of inspiration, _Black_ is about as configurable as _gofmt_. This is
   9 deliberate.
  10
  11 Bug reports and fixes are always welcome! Please follow the
  12 [issue template on GitHub](https://github.com/psf/black/issues/new) for best results.
  13
  14 Before you suggest a new feature or configuration knob, ask yourself why you want it. If
  15 it enables better integration with some workflow, fixes an inconsistency, speeds things
  16 up, and so on - go for it! On the other hand, if your answer is "because I don't like a
  17 particular formatting" then you're not ready to embrace _Black_ yet. Such changes are
  18 unlikely to get accepted. You can still try but prepare to be disappointed.
  19
  20 ## Technicalities
  21
  22 Development on the latest version of Python is preferred. As of this writing it's 3.8.
  23 You can use any operating system. I am using macOS myself and CentOS at work.
  24
  25 Install all development dependencies using:
  26
  27 ```console
  28 $ pipenv install --dev
  29 $ pipenv shell
  30 $ pre-commit install
  31 ```
  32
  33 If you haven't used `pipenv` before but are comfortable with virtualenvs, just run
  34 `pip install pipenv` in the virtualenv you're already using and invoke the command above
  35 from the cloned _Black_ repo. It will do the correct thing.
  36
  37 Before submitting pull requests, run lints and tests with:
  38
  39 ```console
  40 $ pre-commit run -a
  41 $ python -m unittest
  42 $ black-primer [-k -w /tmp/black_test_repos]
  43 ```
  44
  45 ## black-primer
  46
  47 `black-primer` is used by CI to pull down well-known _Black_ formatted projects and see
  48 if we get source code changes. It will error on formatting changes or errors. Please run
  49 before pushing your PR to see if you get the actions you would expect from _Black_ with
  50 your PR. You may need to change
  51 [primer.json](https://github.com/psf/black/blob/master/src/black_primer/primer.json)
  52 configuration for it to pass.
  53
  54 For more `black-primer` information visit the
  55 [documentation](https://github.com/psf/black/blob/master/docs/black_primer.md).
  56
  57 ## Hygiene
  58
  59 If you're fixing a bug, add a test. Run it first to confirm it fails, then fix the bug,
  60 run it again to confirm it's really fixed.
  61
  62 If adding a new feature, add a test. In fact, always add a test. But wait, before adding
  63 any large feature, first open an issue for us to discuss the idea first.
  64
  65 ## Finally
  66
  67 Thanks again for your interest in improving the project! You're taking action when most
  68 people decide to sit and watch.