CONTRIBUTING.md

   1 # Contributing to Black
   2
   3 Welcome! Happy to see you willing to make the project better. Have you
   4 read the entire [README](README.md) yet?
   5
   6
   7 ## Bird's eye view
   8
   9 In terms of inspiration, *Black* is about as configurable as *gofmt* and
  10 *rustfmt* are.  This is deliberate.
  11
  12 Bug reports and fixes are always welcome!  Please follow the issue
  13 template for best results.
  14
  15 Before you suggest a new feature or configuration knob, ask yourself why
  16 you want it.  If it enables better integration with some workflow, fixes
  17 an inconsistency, speeds things up, and so on - go for it!  On the other
  18 hand, if your answer is "because I don't like a particular formatting"
  19 then you're not ready to embrace *Black* yet. Such changes are unlikely
  20 to get accepted. You can still try but prepare to be disappointed.
  21
  22
  23 ## Technicalities
  24
  25 Development on the latest version of Python is preferred.  As of this
  26 writing it's 3.6.4.  You can use any operating system.  I am using macOS
  27 myself and CentOS at work.
  28
  29 Install all development dependencies using:
  30 ```
  31 $ pipenv install --dev
  32 ```
  33 If you haven't used `pipenv` before but are comfortable with virtualenvs,
  34 just run `pip install pipenv` in the virtualenv you're already using and
  35 invoke the command above from the cloned Black repo. It will do the
  36 correct thing.
  37
  38 Before submitting pull requests, run tests with:
  39 ```
  40 $ python setup.py test
  41 ```
  42
  43 Also run mypy and flake8 on `black.py` and `test_black.py`.  Travis will
  44 run all that for you but if you left any errors here, it will be quicker
  45 and less embarrassing to fix them locally ;-)
  46
  47
  48 ## Hygiene
  49
  50 If you're fixing a bug, add a test.  Run it first to confirm it fails,
  51 then fix the bug, run it again to confirm it's really fixed.
  52
  53 If adding a new feature, add a test.  In fact, always add a test.  But
  54 wait, before adding any large feature, first open an issue for us to
  55 discuss the idea first.
  56
  57
  58 ## Finally
  59
  60 Thanks again for your interest in improving the project!  You're taking
  61 action when most people decide to sit and watch.