Skip to content

docs: add centralized documentation hub and AI agent instructions for Hamekoz org#4

Merged
RodrigoPereyraDiaz merged 4 commits into
mainfrom
copilot/add-centralized-documentation-instructions
Apr 11, 2026
Merged

docs: add centralized documentation hub and AI agent instructions for Hamekoz org#4
RodrigoPereyraDiaz merged 4 commits into
mainfrom
copilot/add-centralized-documentation-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 11, 2026

  • docs/code-format/dotnet.md — reemplazar "8.0.x" por "8.0.204" en el ejemplo de global.json
  • docs/tooling/vscode.md — corregir tilde: "Si es útil" → "Sí es útil"
  • docs/ai/agent-instructions.md — ajustar enlace del paso 5 para apuntar a ai-task-log.md (log de instancia) con referencia a la plantilla
  • Markdownlint: 0 errores
  • Prettier: todos los archivos modificados pasan

Copilot AI and others added 2 commits April 11, 2026 12:52
- Add docs/ directory with full organizational standards documentation
- Add docs/conventions/ (conventional-commits, semantic-versioning, branching)
- Add docs/architecture/ (12-factor, clean-code, clean-architecture, microservices)
- Add docs/code-format/ (common rules, .NET, Ruby on Rails)
- Add docs/ci-cd/ (general guide, .NET, Ruby on Rails)
- Add docs/ai/ (agent-instructions, task-template, review-policy, ai-task-log-template)
- Add docs/adoption/onboarding-checklist.md
- Add .github/copilot-instructions.md for org-wide Copilot context
- Update README.md and profile/README.md to reference new docs
- Update cspell-project-words.txt with new technical terms

Agent-Logs-Url: https://github.com/hamekoz/.github/sessions/afd9fb14-511e-4c63-a316-f11ca7a8ef53

Co-authored-by: RodrigoPereyraDiaz <355298+RodrigoPereyraDiaz@users.noreply.github.com>
…ength rule

Agent-Logs-Url: https://github.com/hamekoz/.github/sessions/afd9fb14-511e-4c63-a316-f11ca7a8ef53

Co-authored-by: RodrigoPereyraDiaz <355298+RodrigoPereyraDiaz@users.noreply.github.com>
- Add docs/tooling/README.md — tooling hub with overview table
- Add docs/tooling/vscode.md — VS Code settings, extensions by stack (.NET, Rails, general)
- Add docs/tooling/devcontainer.md — devcontainer conventions, examples with DB
- Add devcontainer-examples/dotnet/devcontainer.json — ready-to-use .NET devcontainer
- Add devcontainer-examples/ruby-on-rails/devcontainer.json — Rails devcontainer
- Add devcontainer-examples/ruby-on-rails/docker-compose.yml — with Postgres + Redis
- Update docs/README.md — add Herramientas de desarrollo section
- Update docs/adoption/onboarding-checklist.md — add tooling items and matrix rows
- Update cspell-project-words.txt — add devcontainer/tooling terms

Agent-Logs-Url: https://github.com/hamekoz/.github/sessions/83dbdd1c-3fa1-4c99-8adb-2d4eca2a3a4a

Co-authored-by: RodrigoPereyraDiaz <355298+RodrigoPereyraDiaz@users.noreply.github.com>
@RodrigoPereyraDiaz RodrigoPereyraDiaz marked this pull request as ready for review April 11, 2026 14:31
Copilot AI review requested due to automatic review settings April 11, 2026 14:31
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Este PR crea un hub centralizado de documentación para estándares organizacionales de Hamekoz, incluyendo guías de tooling (VS Code/Dev Containers) y políticas/instrucciones para el uso de agentes IA.

Changes:

  • Agrega el índice central docs/README.md y documentación base de convenciones (Conventional Commits, SemVer, branching), arquitectura y formato.
  • Incorpora guías de tooling (VS Code y Dev Containers) + ejemplos de devcontainer para .NET y Rails.
  • Centraliza/actualiza instrucciones de IA (plantillas, política de revisión, instrucciones de agentes/Copilot) y checklist de onboarding.

Reviewed changes

Copilot reviewed 29 out of 30 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
README.md Actualiza README raíz para apuntar al hub docs/ y workflows reutilizables.
profile/README.md Reestructura el perfil público para referenciar estándares y requisitos mínimos.
docs/README.md Crea índice principal del hub de documentación.
docs/tooling/README.md Agrega índice de tooling y principio rector.
docs/tooling/vscode.md Guía de configuración/extensiones VS Code por stack.
docs/tooling/devcontainer.md Guía de Dev Containers + convenciones y ejemplos.
docs/conventions/conventional-commits.md Define política de Conventional Commits y ejecución con workflow.
docs/conventions/semantic-versioning.md Define SemVer + relación con commits + version.txt.
docs/conventions/branching.md Define estrategia de branching, hotfixes y protección de ramas.
docs/code-format/README.md Reglas comunes de formato + herramientas (Prettier/eclint/etc.).
docs/code-format/dotnet.md Convenciones de formato .NET (dotnet format, naming, async, etc.).
docs/code-format/ruby-on-rails.md Convenciones de formato Rails (RuboCop, estructura, tests).
docs/ci-cd/README.md Guía general de CI/CD y referencia de workflows reutilizables.
docs/ci-cd/dotnet.md Guía de workflows CI/CD .NET y ejemplo de pipeline.
docs/ci-cd/ruby-on-rails.md Guía CI/CD Rails (lint/tests/security/coverage y ejemplo workflow).
docs/architecture/clean-architecture.md Documento de Clean Architecture y reglas de dependencia.
docs/architecture/clean-code.md Criterios de Clean Code (nombres, errores, tests, etc.).
docs/architecture/12-factor.md Checklist 12 Factor App por tipo de servicio.
docs/architecture/microservices.md Principios de microservicios (contratos, resiliencia, observabilidad).
docs/ai/agent-instructions.md Instrucciones organizacionales para agentes IA.
docs/ai/review-policy.md Política de revisión humana obligatoria para cambios por IA.
docs/ai/task-template.md Plantilla estándar para pedir tareas a agentes IA.
docs/ai/ai-task-log-template.md Plantilla de historial de tareas IA por repositorio.
docs/adoption/onboarding-checklist.md Checklist de onboarding + matriz por stack.
devcontainer-examples/dotnet/devcontainer.json Ejemplo de devcontainer para proyectos .NET.
devcontainer-examples/ruby-on-rails/devcontainer.json Ejemplo de devcontainer para Rails.
devcontainer-examples/ruby-on-rails/docker-compose.yml Compose de ejemplo para Rails con Postgres y Redis.
cspell-project-words.txt Agrega vocabulario técnico para CSpell.
.github/copilot-instructions.md Instrucciones organizacionales para GitHub Copilot.
Comments suppressed due to low confidence (1)

docs/ai/review-policy.md:110

  • La sección “Registro de la revisión” indica actualizar el “historial de tareas IA” pero enlaza a ai-task-log-template.md (plantilla). Esto puede inducir a actualizar la plantilla en vez del log real; sugiero apuntar a docs/ai/ai-task-log.md (o aclarar “actualizar el log usando esta plantilla”).
## Registro de la revisión

Después de cada merge de cambios generados por IA, actualizar el [historial de tareas IA](./ai-task-log-template.md) del repositorio con el resultado de la revisión.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/code-format/dotnet.md Outdated
```json
{
"sdk": {
"version": "8.0.x",
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

El ejemplo de global.json usa "version": "8.0.x", pero el campo sdk.version requiere una versión concreta del SDK (p.ej. 8.0.2xx). Con rollForward se puede permitir avanzar a latestMinor, pero sin comodines; conviene reemplazarlo por una versión específica para que el ejemplo sea copiable y funcione.

Suggested change
"version": "8.0.x",
"version": "8.0.204",

Copilot uses AI. Check for mistakes.
Comment thread docs/tooling/vscode.md Outdated
| ------------------------- | -------------- | ------------------------------------------------------------ |
| `.vscode/settings.json` | ✅ Sí | Garantiza consistencia entre desarrolladores |
| `.vscode/extensions.json` | ✅ Sí | Facilita el setup inicial |
| `.vscode/launch.json` | ✅ Si es útil | Configuraciones de debug reutilizables por el equipo |
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

En la tabla, “✅ Si es útil” debería llevar tilde (“✅ Sí es útil”) para evitar ambigüedad (condicional vs afirmación) y mantener consistencia con “✅ Sí” en las filas anteriores.

Suggested change
| `.vscode/launch.json` |Si es útil | Configuraciones de debug reutilizables por el equipo |
| `.vscode/launch.json` | es útil | Configuraciones de debug reutilizables por el equipo |

Copilot uses AI. Check for mistakes.
Comment thread docs/ai/agent-instructions.md Outdated
2. Verificar que no exista una solución similar ya implementada.
3. Identificar y declarar qué archivos serán modificados.
4. Ejecutar lint y tests después de los cambios.
5. Registrar la tarea en el [historial de tareas IA](./ai-task-log-template.md) del repositorio.
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

En el “Proceso de tarea”, el paso 5 enlaza al template ai-task-log-template.md como si fuera el historial a actualizar. Para trazabilidad, normalmente se debería registrar en el log de instancia del repo (docs/ai/ai-task-log.md) usando esa plantilla como formato; sugiero ajustar el texto/enlace para evitar confusión.

Suggested change
5. Registrar la tarea en el [historial de tareas IA](./ai-task-log-template.md) del repositorio.
5. Registrar la tarea en el [historial de tareas IA](./ai-task-log.md) del repositorio, usando la [plantilla de log](./ai-task-log-template.md) como formato.

Copilot uses AI. Check for mistakes.
- fix: use concrete SDK version 8.0.204 in global.json example
- fix: add missing accent in launch.json table row (Si → Sí)
- fix: link step 5 to ai-task-log.md instance log with reference to template

Agent-Logs-Url: https://github.com/hamekoz/.github/sessions/a7d82108-a39f-4341-be84-3236b08c988d

Co-authored-by: RodrigoPereyraDiaz <355298+RodrigoPereyraDiaz@users.noreply.github.com>
@RodrigoPereyraDiaz RodrigoPereyraDiaz merged commit c8e3089 into main Apr 11, 2026
3 checks passed
@RodrigoPereyraDiaz RodrigoPereyraDiaz deleted the copilot/add-centralized-documentation-instructions branch April 11, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants