Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.8 KB

CONTRIBUTING.rst

File metadata and controls

62 lines (44 loc) · 1.8 KB
Raw

Contributing to Spinneret

Spinneret is an open source project that encourages community contributions to all aspects:

Code

  • Propose all code changes via a pull request in the GitHub repository;
  • Use Twisted's coding standard;
  • Ensure codes changes have unit tests and good 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 Spinneret 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. Glyph wrote a compelling email on this topic, it's worth reading if you're a reviewer or a contributor.