docs/contributing/index.rst

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