docs/contributing/index.md

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