]> git.madduck.net Git - etc/vim.git/blob - docs/contributing_to_black.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

b911b465afd352aae1942e849a127911a6401b8d
[etc/vim.git] / 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 ### News / Changelog Requirement
64
65 `Black` has CI that will check for an entry corresponding to your PR in `CHANGES.md`. If
66 you feel this PR not require a changelog entry please state that in a comment and a
67 maintainer can add a `skip news` label to make the CI pass. Otherwise, please ensure you
68 have a line in the following format:
69
70 ```md
71 - `Black` is now more awesome (#X)
72 ```
73
74 To workout X, please use
75 [Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This
76 is not perfect but saves a lot of release overhead as now the releaser does not need to
77 go back and workout what to add to the `CHANGES.md` for each release.
78
79 ### Docs Testing
80
81 If you make changes to docs, you can test they still build locally too.
82
83 ```console
84 $ pip install -r docs/requirements.txt
85 $ pip install [-e] .[d]
86 $ sphinx-build -a -b html -W docs/ docs/_build/
87 ```
88
89 ## black-primer
90
91 `black-primer` is used by CI to pull down well-known _Black_ formatted projects and see
92 if we get source code changes. It will error on formatting changes or errors. Please run
93 before pushing your PR to see if you get the actions you would expect from _Black_ with
94 your PR. You may need to change
95 [primer.json](https://github.com/psf/black/blob/master/src/black_primer/primer.json)
96 configuration for it to pass.
97
98 For more `black-primer` information visit the
99 [documentation](https://github.com/psf/black/blob/master/docs/black_primer.md).
100
101 ## Hygiene
102
103 If you're fixing a bug, add a test. Run it first to confirm it fails, then fix the bug,
104 run it again to confirm it's really fixed.
105
106 If adding a new feature, add a test. In fact, always add a test. But wait, before adding
107 any large feature, first open an issue for us to discuss the idea first.
108
109 ## Finally
110
111 Thanks again for your interest in improving the project! You're taking action when most
112 people decide to sit and watch.