Skip to content

DevOps Rule Book

Mathew Topper edited this page Dec 2, 2020 · 11 revisions

These are the current rules for code submission and acceptance for the development team. These rules are subject to change depending on the will of the programmers.

  1. Development follows a trunk based development paradigm. No new development branches are to be made in the main repository.
  2. Updates (beyond very minor changes) should never be made directly to the main repository.
  3. All updates should be submitted via pull request.
  4. All pull requests should be reviewed by a member of the development team prior to merging.
  5. Please check that all new files contain the GPL header
  6. If examples\RM3\optimization.m has been modified, please check that the content / line numbers in docs\user\optimization.rst are still valid
  7. Merging can only be done after sign off from the reviewer, and no major additions should be made to the code before merging without additional review.
  8. Merges should be made using the "Squash and Merge" option, only.
  9. When squashing and merging, please edit the automatically generated commit message to succinctly capture the most pertinent changes.

Clone this wiki locally