]> git.madduck.net Git - etc/vim.git/blob - docs/contributing/index.rst

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:

correct Vim integration code (#2853)
[etc/vim.git] / docs / contributing / index.rst
1 Contributing
2 ============
3
4 .. toctree::
5   :hidden:
6
7   the_basics
8   gauging_changes
9   issue_triage
10   release_process
11   reference/reference_summary
12
13 Welcome! Happy to see you willing to make the project better. Have you read the entire
14 `user documentation <https://black.readthedocs.io/en/latest/>`_ yet?
15
16 .. rubric:: Bird's eye view
17
18 In terms of inspiration, *Black* is about as configurable as *gofmt* (which is to say,
19 not very). This is deliberate. *Black* aims to provide a consistent style and take away
20 opportunities for arguing about style.
21
22 Bug reports and fixes are always welcome! Please follow the
23 `issue template on GitHub <https://github.com/psf/black/issues/new>`_ for best results.
24
25 Before you suggest a new feature or configuration knob, ask yourself why you want it. If
26 it enables better integration with some workflow, fixes an inconsistency, speeds things
27 up, and so on - go for it! On the other hand, if your answer is "because I don't like a
28 particular formatting" then you're not ready to embrace *Black* yet. Such changes are
29 unlikely to get accepted. You can still try but prepare to be disappointed.
30
31 .. rubric:: Contents
32
33 This section covers the following topics:
34
35 - :doc:`the_basics`
36 - :doc:`gauging_changes`
37 - :doc:`release_process`
38 - :doc:`reference/reference_summary`
39
40 For an overview on contributing to the *Black*, please checkout :doc:`the_basics`.
41
42 If you need a reference of the functions, classes, etc. available to you while
43 developing *Black*, there's the :doc:`reference/reference_summary` docs.