Skip to content

Guidelines for maintainers

Sameer Deshmukh edited this page Jan 12, 2016 · 1 revision

These guidelines are for people with push access to nmatrix. They outline a general (informal) procedure to be followed when a Pull Request is to be merged into nmatrix.

  • Read code and verify if it confirms to the code guidelines.
  • Make sure interfaces are Ruby-like and there aren't abbreviations used for method names or options etc.
  • Travis builds MUST be passing.
  • Commit messages should be non-ambiguous and should cater to a single feature. In case of a single feature split into multiple commit messages, the commits should be rebased into a single commit.
  • Adequate documentation must be provided for each new method added/modified.
  • At least 2 maintainers must review a Pull Request before it has been merged.
  • All sources must be properly cited. If the code is ported from another project, documentation of steps taken to obtain permission for re-use must be included (unless the license is compatible, in which case the project should be cited appropriately).
Clone this wiki locally