When contributing changes to this repository, one must adhere to the following rules:
- create a new feature branch off of staging.
- make your commits to the branch, with the commit messages adhering to the commit messages section below
- Push your changes to github
- Create a pull request from your branch into the staging branch
###Formatting Contributor Branch Names Please adhere to the following branch name guidelines when creating development branches in this repository:
- Include a prefix indicating the intent of this branch according to this hierarchy:
- rc/ = releaes candidate
- f/ = feature
- b/ = bug fix
- e/ = experimental/exploratory work
- Follow that prefix with your initials.
- Then, add the name of the Jira ticket associated with the code change.
- Lastly, include a brief description of the impact of the change.
- Example:
f/sm-HLX2-482-csv-pt-creation
The following describes how we expect commit messages to be formatted, and is borrowed from Spray's contributing guide's
git Commit Messages section.
The commit should start with one of the following symbols:
+ = additive to public API
! = breaking to public API
= = no change to public API
Then most low-level module impacted, e.g. fe-aep <- components <- cohorts <- details <- organs. A colon and then a short description of the change in imperative present tense.
Example:
git commit -m '=data: loosen validation to allow any date to be valid"