Git standards
The following explains how to work off master in the mono-repository
Update the master branch
Make sure that your main branch is up to date by pulling the latest changes
Branch off main
Name your branch ProjectName/Description. For example: platform/addingEcoSystemProject
Commit changes and push
Commit the changes following the set standard:
- app_name
- action (add,remove,update,fix)
- ticket_number (optional)
- description
Note that the commit message format will be enforced via git hooks.
for example:
platform #add JRA111 new pb-client payment service
- push commits to your branch
Update your branch from main
- Make sure you have the latest changes on your main branch
- Merge the main branch into your branch
- When resolving conflicts, consult with the other teams if needed
Merge back into main
- Create a prod release of the platform and ensure that there are no errors or warnings.
- Serve up the platform and make sure everything is working as expected
- Create a merge request and assign it to one of the designated reviewers (Delete the branch after the merge is accepted)
- When creating a merge review, ensure that you are sitting with the reviewer if possible (This is to ensure that the code is reviewed and merged in without falling behind on latest changes)
Guidelines for developers and reviewers
Developers
- Develop in small incremental iterations
- Branches should be merged within 1-2 days
- Keep the code simple and small enough to review
- Ensure that your code is covered by unit tests if needed
Reviewer
- Is the code logical? (naming conventions, use of functions, data flows, practices)
- Is it difficult to review the code, based on large features?
- Is it up to date?