If you want to implement a new feature, please check in issues if there isn't already an occcurence of this feature. If it's not the case :
- Open an issue
- Describe what you want to build
- Add labels to your issue, cf labels list
- I you want to add labels, contact an admin.
- Choose a deadline for your issue, do not drop your issues
Each issue need to have a corresponding own branch, with issue number, meaning : no branch without issue.
- For a new feature, branch name start with
f/ - For an edit, branch name start with
e/ - For a refactor, branch name start with
r/ - For a documentation, branch name start with
d/ - For a bug fix, branch name start with
bf/
Exemples:
- For issue
1namedCreate statistics dashboard:f/1-statistics-dashboard - Or issue
42namedEdit logo on landing page:e/42-change-logo-landing-page - For exemple a proper branch name:
f/1-init-docker-architecture
For each commit, you need to reference the issues.
To do this put # followed by the issue number in your commit message.
Exemple :
git commit -m 'feat: #2 Imported OS logo'
For each commit, respect the commit conventions.
Exemple to ban: 😠
git commit -m 'bugfix'
git commit -m 'oups'
Exemple with some class: 😎
git commit -m 'chore: #42 add libs for CI'
NEVER commit on main directly.
Once a feature is ready, create a merge request into develop.
Once merged in develop, create a merge request verintos main.
This on is to be reviewed by 2 peers 👼👼.
Deletes all unused branches.