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

Documentation: include Wing IDE 8 integrations (GH-2733)
[etc/vim.git] / docs / contributing / the_basics.md
1 # The basics
2
3 An overview on contributing to the _Black_ project.
4
5 ## Technicalities
6
7 Development on the latest version of Python is preferred. As of this writing it's 3.9.
8 You can use any operating system.
9
10 Install development dependencies inside a virtual environment of your choice, for
11 example:
12
13 ```console
14 $ python3 -m venv .venv
15 $ source .venv/bin/activate
16 (.venv)$ pip install -r test_requirements.txt
17 (.venv)$ pip install -e .[d]
18 (.venv)$ pre-commit install
19 ```
20
21 Before submitting pull requests, run lints and tests with the following commands from
22 the root of the black repo:
23
24 ```console
25 # Linting
26 (.venv)$ pre-commit run -a
27
28 # Unit tests
29 (.venv)$ tox -e py
30
31 # Optional Fuzz testing
32 (.venv)$ tox -e fuzz
33
34 # Optional CI run to test your changes on many popular python projects
35 (.venv)$ black-primer [-k -w /tmp/black_test_repos]
36 ```
37
38 ### News / Changelog Requirement
39
40 `Black` has CI that will check for an entry corresponding to your PR in `CHANGES.md`. If
41 you feel this PR does not require a changelog entry please state that in a comment and a
42 maintainer can add a `skip news` label to make the CI pass. Otherwise, please ensure you
43 have a line in the following format:
44
45 ```md
46 - `Black` is now more awesome (#X)
47 ```
48
49 Note that X should be your PR number, not issue number! To workout X, please use
50 [Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This
51 is not perfect but saves a lot of release overhead as now the releaser does not need to
52 go back and workout what to add to the `CHANGES.md` for each release.
53
54 ### Style Changes
55
56 If a change would affect the advertised code style, please modify the documentation (The
57 _Black_ code style) to reflect that change. Patches that fix unintended bugs in
58 formatting don't need to be mentioned separately though.
59
60 ### Docs Testing
61
62 If you make changes to docs, you can test they still build locally too.
63
64 ```console
65 (.venv)$ pip install -r docs/requirements.txt
66 (.venv)$ pip install [-e] .[d]
67 (.venv)$ sphinx-build -a -b html -W docs/ docs/_build/
68 ```
69
70 ## black-primer
71
72 `black-primer` is used by CI to pull down well-known _Black_ formatted projects and see
73 if we get source code changes. It will error on formatting changes or errors. Please run
74 before pushing your PR to see if you get the actions you would expect from _Black_ with
75 your PR. You may need to change
76 [primer.json](https://github.com/psf/black/blob/main/src/black_primer/primer.json)
77 configuration for it to pass.
78
79 For more `black-primer` information visit the
80 [documentation](./gauging_changes.md#black-primer).
81
82 ## Hygiene
83
84 If you're fixing a bug, add a test. Run it first to confirm it fails, then fix the bug,
85 run it again to confirm it's really fixed.
86
87 If adding a new feature, add a test. In fact, always add a test. But wait, before adding
88 any large feature, first open an issue for us to discuss the idea first.
89
90 ## Finally
91
92 Thanks again for your interest in improving the project! You're taking action when most
93 people decide to sit and watch.