Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
55 lines (38 loc) · 1.93 KB

CONTRIBUTING.rst

File metadata and controls

55 lines (38 loc) · 1.93 KB

Contributing to Klein

Klein is an open source project that welcomes contributions of all kinds coming from the community.

These include:

Here's some suggestions to make the contributing process much smoother for you:

Code

  • Propose all patches through a pull request in the GitHub repo.
  • Use Twisted's code style guide for all code you touch, as long as it doesn't break a public API.
  • Make sure your patch has tests, since untested code is buggy code.
  • If it's a new feature, add an example into the examples directory and add it to the index.
  • Add yourself to AUTHORS.
  • Put [WIP] in the title if it's a work in progress pull request.

Documentation

  • The header order:

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

Header 2
========

Header 3
--------

Header 4
~~~~~~~~

  • Use gender-neutral pronouns, if you have to at all.

  • Put each sentence on a different line, if you can -- this makes diffs much easier to read. You will need to add an indent to make it continue lists.

Reviewing

All code that goes into Klein must be reviewed by at least one other person who is not an author of the patch. This can help prevent bugs from slipping through the net, gives another source for improvements, and makes sure that the code meets standard.

Reviewers should read Glyph's mailing list post on reviewing -- code and docs don't have to be perfect, only better.