Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.61 KB

Documentation

We use a fork and pull model, you can read about forking repos at github help.

Any typo fixes, spelling fixes, fixes in documentation, or README.md can be done without any further considerations! Simply do the fixes in your cloned repo and create a pull request.

Issues

If you have any questions you can ask them using github issue. Simply ignore the template in this case.

See also FAQ for some details about creating issues.

General

We recommend that you read:

Code

Before you issue a pull request that modifies code:

Architecture

Before you start making fundamental changes:

  • Propose it by creating a github issue for discussions.
  • You should read the design document.
  • Create a decision describing you want to do to keep the discussion more efficient and architecture documented.

Labels

  • If you do not want your PR to be merged, please label the PR with the label "work in progress".
  • If you included changes after a review and you think you are ready, please tag your PR with the label "ready to merge".