:warning: master branch can never be updated without lead team's approval, do not push on master.
Tag | Usage |
---|---|
<cfg> |
Update .eslintrc / tsconfig.json / package.json |
<doc> |
Update README.md / JSDoc / Comments. |
<feat> |
Create a new feature or update an existing one. |
<fix> |
Fix of a broken feature. |
<pkg> |
Add / remove package. |
<ref> |
Code refactoring. |
git commit -m '<commitTag> commit description...'
Commits should never contain more than one of the above-named categories.
A new feature and its documentation are two separated commits, even if it's a single line comment.
For instance, if you create a new component, best practice would be to commit separately HTML, CSS and logic.
Commit often.
Write your commit description with words, not sentences.
Commits description should never be omitted.
Any branch name related to an issue should be prefixed with the issue number. See an example below.
2-code-refactoring
Only dev and master deviates from this rule.
Before openning a pull request you need to follow these steps;
When an issue is closed, the corresponding branch must be deleted.