-
Notifications
You must be signed in to change notification settings - Fork 0
Processo Commit Pattern Rules
- The entire team workflow must be in English: commits (including body and description), branch names, pull request names and pull request descriptions.
- Commit messages must be written in lowercase, following the format defined in this document.
- The team follows the Conventional Commits standard, adapted to the rules in this document.
-
main: stable production/release branch. -
develop-x: development branch for the current sprint. - Card branches: created from
develop-xto implement backlog tasks.
The branch name must copy the Jira card name, with the card number at the beginning.
Format:
<card-number>-<card-name>
Example:
- Card number and name:
81, Create table to view employees - Branch name:
81-Create-table-to-view-employees
Rules:
- Always start with the card number.
- Keep the name equivalent to the card title.
- Replace spaces with
-.
When syncing your branch with develop-x, use a lowercase maintenance commit.
Example:
chore(81): syncs branch with develop-3
When finishing the card, open a pull request to develop-x.
Suggested merge message:
merge(81): merges 81-create-table-to-view-employees into develop-3
Format:
type(card-number): short imperative description
Example:
feat(81): adds table to view employees
How to fill it:
-
type: change category (e.g.,feat,fix,docs). -
card-number: Jira card identifier (e.g.,scrum-81). -
description: short, direct summary in the present tense, indicating what the commit does. - The entire message must be in lowercase.
If needed, add a complementary description below the commit title to explain context, technical decision, or impact.
Example:
feat(scrum-81): adds table to view employees
includes name, department, and status columns to make lookup easier.
| Type | When to use | Example |
|---|---|---|
feat |
New functionality in the system. | feat(81): adds department filter to the listing |
fix |
Bug fix or incorrect behavior correction. | fix(107): fixes validation error in the registration endpoint |
build |
Build, packaging, compilation script, or build tool versioning changes. | build(120): updates build script to generate staging artifact |
docs |
Documentation creation or updates. | docs(45): updates api installation guide |
chore |
Maintenance tasks that do not change business rules (configuration, dependencies, branch sync). | chore(88): updates development dependencies |
ci |
Changes to continuous integration and pipelines (GitHub Actions, Jenkins, etc.). | ci(98): adjusts pipeline to run integration tests |
perf |
Performance improvement without changing business rules. | perf(134): reduces duplicate queries in user search |
refactor |
Refactoring without changing final functional behavior. | refactor(76): reorganizes authentication service to reduce coupling |
test |
Addition or adjustment of automated tests. | test(90): adds tests for access permission rules |
remove |
Removal of obsolete files, code, or resources. | remove(66): removes legacy report endpoint |
style |
Style and formatting changes with no functional impact. | style(52): standardizes indentation and quotes in api files |
The pull request name must match the Jira card name, with the number at the beginning.
Format:
<card-number> - <card name>
Example:
81 - Create table to view employees
The description must include at least the Jira card link.
Minimum example:
https://exemplo.atlassian.net/browse/SCRUM-81
- When making the first commit in the branch, open the pull request as
draft. - Keep frequent pushes to make tracking and review easier.
- Change from
drafttoready for reviewwhen the implementation is ready for review.
- All comments must be in Portuguese.
- Explain the reason for the suggestion objectively and respectfully.
- Whenever possible, indicate how to fix it.
-
enhancement: new features or improvements. -
bug: bug fixes and hotfixes. -
documentation: documentation changes. -
help wanted: task that needs support. -
question: blocker due to doubt or lack of information.