Back to Black

Contributing

docs/contributing/index.md

26.3.11.3 KB
Original Source

Contributing

{toctree}
---
hidden:
---

the_basics
gauging_changes
issue_triage
release_process

Welcome! Happy to see you willing to make the project better. Have you read the entire user documentation yet?

{rubric}

In terms of inspiration, Black is about as configurable as gofmt (which is to say, not very). This is deliberate. Black aims to provide a consistent style and take away opportunities for arguing about style.

Bug reports and fixes are always welcome! Please follow the issue templates on GitHub for best results.

Before you suggest a new feature or configuration knob, ask yourself why you want it. If it enables better integration with some workflow, fixes an inconsistency, speeds things up, and so on - go for it! On the other hand, if your answer is "because I don't like a particular formatting" then you're not ready to embrace Black yet. Such changes are unlikely to get accepted. You can still try but prepare to be disappointed.

{rubric}

This section covers the following topics:

  • {doc}the_basics
  • {doc}gauging_changes
  • {doc}release_process

For an overview on contributing to the Black, please checkout {doc}the_basics.