- read this developer guide completely for essential information and practices to follow
...
...
@@ -53,7 +54,7 @@ Must merge back into:
`develop` and `main`
Branch naming convention:
`<issue number>-hotfix-*` (automatically generated through the issue > create branch workflow, see [branching workflow](branching-workflow))
`<issue number>-hotfix-*` (automatically generated through the issue > create branch workflow, see [branching workflow](#branching-workflow))
### Feature branches
> Feature branches are used to develop new features for the upcoming or a distant future release. When starting development of a feature, the target release in which this feature will be incorporated may well be unknown at that point. The essence of a feature branch is that it exists as long as the feature is in development, but will eventually be merged back into develop (to definitely add the new feature to the upcoming release) or discarded (in case of a disappointing experiment).
...
...
@@ -67,7 +68,7 @@ Must merge back into:
`develop`
Branch naming convention:
`<issue number>-feature-*` (automatically generated through the issue > create branch workflow, see [branching workflow](branching-workflow))
`<issue number>-feature-*` (automatically generated through the issue > create branch workflow, see [branching workflow](#branching-workflow))
# Branching workflow
...
...
@@ -75,6 +76,7 @@ This is the process to create a new branch. It is mandatory to first create an i
| > 5 | Epic | should be upgraded to an Epic and broken down into smaller issues |
### Labels
Set the labels, helpful to categorize the issue :
- who is the lead on the issue ? (helps to clarify responsibility of the work)
- what theme does the issue pertain to ? (refactoring, data management, a part of the simulation engine, etc.)
- what is the priority level ?
### Due date
Set the due date for the issue. Useful to organize work and indicate the level of urgency of the feature or fix.
### Iteration
Assign the issue to the appropriate Iteration cadence (if there is one).
# Push rules
The online repository has rules on the format of commit messages as well as branch names.
## Branch names
Branch names should always be created from issues, and the Gitlab repository settings are such that their suggested name should always match the branch name push rule.
Branch names should always be created from Issues, and the Gitlab repository settings are such that their suggested name should always match the branch name push rule.
When creating a branch, always check that you are branching from the correct source branch (see [Branching strategy : git-flow](#branching-strategy-git-flow))