Skip to content

Commit 9b38328

Browse files
committed
docs: add git conventions to README.md
1 parent 1a3561f commit 9b38328

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,3 +140,10 @@ The following are lists of conventions that either *should* be followed or *must
140140
- Code must compile without Compiler Warnings
141141
- Code should compile without relevant Sonar/SonarQube Warnings
142142
143+
#### Git
144+
145+
- There are no comments including `TODO` on the `main` or `develop` branches
146+
- Branch names are as follows:
147+
- features: `feature/<ticket-number>_<short-description>`
148+
- bugs: `bugfix/<ticket-number>_<short-description>`
149+
- Commit messages are written according to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

0 commit comments

Comments
 (0)