feature/***-***for enhancements and additional capabilitiesfix/***-***for when bugs are addressed or broken things get fixed into working thingsupdate/***-***for incremental changes that do not add a new feature but rather improve the existing onesinternal/***-***for documentation changes or changes that do not update the functionality of the program
- Use the pull request & issue templates
- Short summary for updates
- Bullet point list that encapsulates in full detail the changes that have been made. No detail is too small
- If there are any known bugs in your branch which will get merged to dev mention them
- Assign developers that worked on the PR
- Assign all other developers on the project as reviewers
- Link any issues that will be resolved by this PR
- Label the PR based on the type of changes made
Dependenciesneeds to be added if versions are incremented or new dependencies are addedEnhancementneeds to be added for feature branches and if changes add new functionality to the productBugneeds to be added for any branches that contain a fixDocumentationneeds to be added for a pull request that primary involves readme updates or inline documentationBackendneeds to be added for any branches that primarily involve the backendFrontendneeds to be added for any branches that primarily target the UIGood First Issueneeds to be added for a pull request where the code changes are good for new developers to easily reviewInternalneeeds to be added for any changes to the continuous integration, continuous deployment pipelines or the configuration of the productTestneeds to be added when adding new jest/enzyme test cases
Note: The same labels also apply to issues. When creating issues use the available templates to appropriately document required information.
- Pull Request must pass testing locally for both assigned and reviewing developer
- Must pass continuous-integration workflow
- Pull Request must be merged by a reviewer who did not work on the branch
- Packaging a release and merging from
devtomastermust happen when all developers are present and the application has undergone a full regression test
