Wiedii — Política de CONTRIBUTING.md
Todo repositorio Wiedii debe tener un CONTRIBUTING.md en su raíz. Este archivo es el contrato de contribución del proyecto: explica a cualquier desarrollador (o agente IA) cómo preparar el entorno, crear ramas, escribir commits y abrir un Merge Request.
Por qué es obligatorio
Sin CONTRIBUTING.md, cada desarrollador que se incorpora a un proyecto tiene que inferir las convenciones o preguntar. Con él, el onboarding al proyecto es autocontenido. Los agentes IA también lo leen como contexto de trabajo cuando no tienen un CLAUDE.md más específico.
Idioma
CONTRIBUTING.md se escribe en inglés (canónico), al igual que README.md y CHANGELOG.md, y se acompaña de su traducción CONTRIBUTING.es.md en archivo independiente con navegación recíproca. Sigue la política de documentacion-bilingue (inglés canónico + español, archivos independientes, anti-drift).
Contenido mínimo obligatorio
| Sección | Contenido |
|---|---|
| Prerequisites | Homebrew, mise, git-flow-next, glab |
| Setup | mise trust && mise run setup (en un clon nuevo mise trust va antes — mise no corre tareas de un config no confiable) |
| Branch model | Git Flow, naming feature/<ticket>-<slug>, base en develop (excepción documentada: repos de entorno único como una wiki pueden usar GitHub Flow sobre main — ver git-flow) |
| Making commits | wietoo commit (native wizard, replaces czg), Conventional Commits, primer commit chore: initial commit |
| Opening a Merge Request | Push + glab, plantilla, no auto-merge, rebase antes de merge |
| Code quality | Resumen de hooks de lefthook activos |
| Dependency updates | Renovate gestiona las versiones — no actualizar manualmente |
| Definition of Done | Checklist de requisitos mínimos para considerar completo un MR |
Plantilla
Usar la plantilla del vault como base: tpl-contributing.
Sustituir:
PROJECT_NAME→ nombre del proyecto (kebab-case)<namespace>→ namespace de GitLab (wildcat,wildcat/frontend, etc.)- Ajustar la sección de hooks según el stack del proyecto
Qué NO debe incluir
- Credenciales, tokens ni secretos de ningún tipo
- Instrucciones específicas de máquina (rutas absolutas del dev local)
- Dependencias de herramientas no instaladas vía Homebrew o mise
- Procesos que contradigan politicas-core
Integración con otros archivos del repositorio
| Archivo | Relación con CONTRIBUTING.md |
|---|---|
README.md | Incluye un enlace a CONTRIBUTING.md en la sección de desarrollo |
CLAUDE.md / AGENTS.md | Referencia CONTRIBUTING.md para contexto adicional del agente |
.gitlab/merge_request_templates/default.md | Complementa el proceso de MR descrito en CONTRIBUTING.md |
Referencias
- repo-setup — checklist completo de nuevo repositorio
- git-flow — política de ramas
- commits — política de mensajes de commit
- lefthook — política de git hooks
- renovate — política de actualizaciones de dependencias