Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 1.47 KB

CONTRIBUTING.rst

File metadata and controls

58 lines (41 loc) · 1.47 KB
Raw

Contributing

flake8-diff is an open source project that encourages community contributions in all aspects:

Code

  • Propose all code changes via a pull request in the GitHub repository;
  • Use our :doc:`development-process`;
  • Ensure code changes have tests and adequate coverage;
  • New features should have examples and documentation;
  • Add yourself to AUTHORS.

Documentation

  • The header order:

    ========
Header 1
========

Header 2
========

Header 3
--------

Header 4
~~~~~~~~

  • Perform at least basic spelling checks;

  • Use gender-neutral language (singular they is great!);

Reviewing

All code that is merged into flake8-diff must be reviewed by at least one person other than an author of the change.

While perfection is a noble goal it often leads to an idea that improvement without achieving perfection is not an improvement. Improvements need only be that, improvements.