Commit & PR Guidelines

Jump to bottom

Jan Ehmueller edited this page Jul 27, 2017 · 4 revisions

Commit a change

Run sbt test and ensure all tests are succeeding
Run sbt scalastyle and ensure you don't violate any rules
Reference the issue you are working on in your commit message
- e.g. Refs #1234: Add implementation of algorithm abc

Create a Pull Request

Merge master into your branch and resolve any merge conflicts
Request reviews from at least two others
Assign yourself
Add labels and a milestone

Merge a Pull Request

Merge only when at least two reviewers have approved the Pull Request
Ensure the Jenkins build is successful
Ensure you don't have merge conflicts
Squash and Merge into master