Skip to content

Developer Guidelines

James Edmondson edited this page Aug 22, 2018 · 5 revisions

The rules for developing code for MADARA and GAMS are very simple.

  1. Follow the Style and Coding Guide for C++. If Java, follow the Java convention. If Python, follow the Python convention. Look at the style of other code and emulate.
  2. To make changes to either repo, always create a branch (or fork the repo) and then submit a pull request to the appropriate repo. This kicks of CI and allows us to run tests on your changes.
  3. If we give you collaborator access to either project, that is NOT a license to commit to master directly. Very few people will do this (James Edmondson and possibly David Kyle). Giving you collaborator access is permission to create your own branches in the repos. If you consistently commit code that breaks master (which everyone depends on as a stable branch), then you will have your collaborator access removed. Additionally, you may be removed as a developer for the project.