Git
Branches
- Create a branch for each features (JIRA ticket number in branch name).
- Name your branch with the number of the JIRA issue and give it a name that clearly describes the feature or fix you are working on.
- If no Jira ticket describes your development and you are not in squad, use
nojira-*
prefix. If you are in a squad, usesquad-$SQUAD_NAME
prefix.
Examples:
jt-2324-fix-talent-bank-multi-filter-on-curriculum
jt-2321-feature-talent-bank
nojira-load-tests-company-list
squad-appointment-feature-1 and squad-appointment-fix-2
Commits
- Add the number of the JIRA issue to your commit message to help retrieve the history and the context of the commit.
- The commit message should represent a milestone in your feature or fix, and should be a chunk of history that stands alone.
- Your commits could be read as the story of how your feature or fix came together.
- Anyone looking at your commits should be able to easily determine what a commit accomplished and why it was made.
Example:
jt-2269 - Add model and form for messages.
jt-2269 - Add API for interacting with messages.
jt-2269 - Add unit tests.
General
- If you want to refactor only, do small commits and try to reduce the number of files per commit. It will be easier to rollback if needed.
- When creating new features, commit in multiple stages if possible. Specs should be the first commit, then start the implementation.
- When your implementation is finished, do a Pull Request, and ask for a Code Review.