-
Notifications
You must be signed in to change notification settings - Fork 0
Repository Standardization
Jhonata Demuner edited this page Apr 8, 2024
·
1 revision
Guidelines for standardizing names and comments.
All names and comments must be written in English. The exception only applies to proper names or project names that are already in Portuguese.
Always create a branch from the master production branch.
The structure should be as follows:
<type>/<card-code>-<branch-name>
The link to the Jira task should be put in the comments.
The branch name must be in lower case, replacing spaces with dashes.
We'll use GitFLow as a reference for organization, using the nomenclatures:
| Type | Description |
|---|---|
| bugfix | For bugs identified after production releases. Use these cases to keep track of the volume of bugs. |
| features | For new features, sections or structures. |
| fix | For fixes within the ongoing sprint or a feature that has not yet been delivered |
| improvement | For flow improvements, optimizations, refactors or changes in the way an action is performed. |
Examples:
Creation of messages reaction module:
feature/SMZ-123-message-reaction
Can't remove friend:
bugfix/SMZ-234-friend-removal
The structure should be as follows:
type(scope-optional): title
| Type | Description |
|---|---|
| build | Build and its dependencies |
| chore | Task within scope |
| ci | CI files and scripts |
| docs | Documentation |
| feat | New feature/implementation |
| fix | Error correction |
| perf | Application performance improvement |
| **code refactoring | |
| revert | Code reversal |
| style | Meaningless code (e.g. formatting) |
| test | Adding tests to the application |
Examples:
Date formatting error:
fix: date format
Add group management screen:
feat(group): add group management screen
Script:
- Add a REVIEWER to review the code.
- Add the GitHub Project task link in the comments and the code in the branch name.