docs/contributing_to_black.md

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