Skip to main content

Documentation 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.

This project uses Conventional Commits to keep the Git history scannable and to enable automated changelog generation. Every commit must follow the <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”).
<type>: <short imperative description>
The description should be concise — aim for 50 characters or fewer — and must not end with a period.

Commit types

TypeWhen to use
featAdding a new feature or capability to the calculator
fixCorrecting a bug or unexpected behaviour
testAdding new tests or modifying existing ones
docsChanges to documentation only (README, docstrings, guides)
refactorCode restructuring that does not change observable behaviour
styleFormatting, whitespace, or naming changes with no logic impact
choreMaintenance tasks: dependency updates, CI configuration, tooling

Good examples

The following commits are drawn from this project’s real history and represent the expected style:
feat: agregar soporte de paréntesis en calculadora
fix: corregir validación de decimales negativos
test: agregar tests para paréntesis anidados
refactor: reorganizar estructura del proyecto (src/, tests/, requirements.txt)
docs: añadir guía de usuario para la GUI
chore: configurar CI/CD con GitHub Actions
Additional examples from CONTRIBUTING.md:
feat: agregar función de historial de operaciones
fix: corregir validación de paréntesis desbalanceados
test: cubrir casos borde en abs_value con negativos

Anti-patterns

Past tense instead of imperativefixed bug
fix: corregir bug

Missing type prefixadd tests
test: agregar tests para función X

Vague or meaningless descriptionfix: stuff
fix: corregir división por cero en GUI

Wrong type for the changefeat: corregir error de validación ← this is a fix, not a feature
fix: corregir error de validación en entrada numérica

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.
Commit messages in this project are written in Spanish, consistent with the existing history. Keep your messages in Spanish so the log reads uniformly for all contributors.

Build docs developers (and LLMs) love