docs/contributing/index.rst

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