]> git.madduck.net Git - etc/vim.git/blob - CONTRIBUTING.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:

571d870452bc4c6f36473d26026b5da83c915b95
[etc/vim.git] / 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.9.
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 Non pipenv install works too:
38
39 ```console
40 $ pip install -r test_requirements
41 $ pip install -e .[d]
42 ```
43
44 Before submitting pull requests, run lints and tests with the following commands from
45 the root of the black repo:
46
47 ```console
48 # Linting
49 $ pre-commit run -a
50
51 # Unit tests
52 $ tox -e py
53
54 # Optional Fuzz testing
55 $ tox -e fuzz
56
57 # Optional CI run to test your changes on many popular python projects
58 $ black-primer [-k -w /tmp/black_test_repos]
59 ```
60
61 ### Docs Testing
62
63 If you make changes to docs, you can test they still build locally too.
64
65 ```console
66 $ pip install -r docs/requirements.txt
67 $ pip install [-e] .[d]
68 $ sphinx-build -a -b html -W docs/ docs/_build/
69 ```
70
71 ## black-primer
72
73 `black-primer` is used by CI to pull down well-known _Black_ formatted projects and see
74 if we get source code changes. It will error on formatting changes or errors. Please run
75 before pushing your PR to see if you get the actions you would expect from _Black_ with
76 your PR. You may need to change
77 [primer.json](https://github.com/psf/black/blob/master/src/black_primer/primer.json)
78 configuration for it to pass.
79
80 For more `black-primer` information visit the
81 [documentation](https://github.com/psf/black/blob/master/docs/black_primer.md).
82
83 ## Hygiene
84
85 If you're fixing a bug, add a test. Run it first to confirm it fails, then fix the bug,
86 run it again to confirm it's really fixed.
87
88 If adding a new feature, add a test. In fact, always add a test. But wait, before adding
89 any large feature, first open an issue for us to discuss the idea first.
90
91 ## Finally
92
93 Thanks again for your interest in improving the project! You're taking action when most
94 people decide to sit and watch.