Commit & PR Guidelines

Jump to bottom

Jan Ehmueller edited this page Mar 4, 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
- run sbt test:scalastyle and ensure your tests don't violate any rules (this is only necessary until issue #63 is merged into master)
reference the issue you are working on in your commit message
- e.g. Refs #1234: adds 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 others have approved the Pull Request
ensure the Jenkins build is successful
ensure there are no scalastyle violations
- will be included in the jenkins build with [issue #63] (https://github.com/bpn1/ingestion/issues/63)
ensure you don't have merge conflicts
squash and merge into master