This project uses Conventional Commits to keep the Git history scannable and to enable automated changelog generation. Every commit must follow theDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/WorkTeam01/team-practice/llms.txt
Use this file to discover all available pages before exploring further.
<type>: <short description> format — reviewers will request changes to commits that do not conform before approving a PR.
Format
Every commit message begins with a type, followed by a colon and space, then a short description written in the imperative mood (e.g. “agregar”, not “agregué” or “agregando”).Commit types
| Type | When to use |
|---|---|
feat | Adding a new feature or capability to the calculator |
fix | Correcting a bug or unexpected behaviour |
test | Adding new tests or modifying existing ones |
docs | Changes to documentation only (README, docstrings, guides) |
refactor | Code restructuring that does not change observable behaviour |
style | Formatting, whitespace, or naming changes with no logic impact |
chore | Maintenance tasks: dependency updates, CI configuration, tooling |
Good examples
The following commits are drawn from this project’s real history and represent the expected style:CONTRIBUTING.md:
Anti-patterns
Common mistakes to avoid
Common mistakes to avoid
Past tense instead of imperative❌
✅
Missing type prefix❌
✅
Vague or meaningless description❌
✅
Wrong type for the change❌
✅
Scope creep in a single commitAvoid bundling unrelated changes into one commit. Each commit should represent a single logical change so that the history stays bisect-friendly and easy to revert.
fixed bug✅
fix: corregir bugMissing type prefix❌
add tests✅
test: agregar tests para función XVague or meaningless description❌
fix: stuff✅
fix: corregir división por cero en GUIWrong type for the change❌
feat: corregir error de validación ← this is a fix, not a feature✅
fix: corregir error de validación en entrada numéricaScope creep in a single commitAvoid bundling unrelated changes into one commit. Each commit should represent a single logical change so that the history stays bisect-friendly and easy to revert.
