docs: define development workflow and AI-agent rules

Abierto Apto para principiantes
#10 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
75/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Área
developer-experience, documentation

Línea de trabajo

Empieza inspeccionando la raíz del repositorio y las instrucciones existentes del workflow de docs/, incluido AGENTS.md si existe. Crea o actualiza las instrucciones de AI en el nivel raíz y documenta el workflow de desarrollo requerido; se considera terminado cuando un nuevo agente de coding puede seguir las reglas sin depender del historial del chat.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Objective

Create explicit rules for AI-assisted development so coding agents do not repeatedly rewrite architecture or introduce uncontrolled complexity.

Required AI workflow

Before changing code:

  1. Read AGENTS.md.
  2. Read the relevant docs under docs/.
  3. Inspect the existing implementation.
  4. State the affected architectural boundary.
  5. Make the smallest coherent change.
  6. Run tests/typecheck/build.
  7. Update docs when behavior or architecture changes.

Rules

  • Do not create duplicate abstractions.
  • Do not move business logic into UI components.
  • Do not add dependencies without a documented reason.
  • Do not change architecture to solve a local bug.
  • Do not claim tests passed unless they were run.
  • Do not mark a ticket complete if acceptance criteria are not met.
  • Prefer small, reviewable changes.
  • Preserve browser portability.
  • Keep ChatGPT DOM code isolated.
  • Treat docs as part of the product architecture.

Acceptance criteria

Root-level AI instructions and the docs workflow make it possible for a new coding agent to continue work safely without relying on chat history.

Lenguaje dominante
CSS
Estrellas
0
Forks
0
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ChinmayOnGithub/queueit

Todos los issues de ChinmayOnGithub/queueit

Issues similares

Más issues de DevTools

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.