Skip to content

Commit 1830c94

Browse files
committed
docs: add git conventions to README.md
1 parent f79cb71 commit 1830c94

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
@@ -142,3 +142,10 @@ The following are lists of conventions that either *should* be followed or *must
142142
- Code must compile without Compiler Warnings
143143
- Code should compile without relevant Sonar/SonarQube Warnings
144144
145+
#### Git
146+
147+
- There are no comments including `TODO` on the `main` or `develop` branches
148+
- Branch names are as follows:
149+
- features: `feature/<ticket-number>_<short-description>`
150+
- bugs: `bugfix/<ticket-number>_<short-description>`
151+
- Commit messages are written according to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

0 commit comments

Comments
 (0)