57 lines (39 loc) · 1.27 KB

AGENTS.md

Este repositorio es parte de la coleccion camino troncal / Semestre 1 de Jeresoft Academy y se rige por la RFC-0001 (manual fundacional).

Objetivo

Crear el mejor recurso educativo posible sobre estructuras de datos en Rust.

Todo cambio debe mejorar simultaneamente:

calidad tecnica
claridad
documentacion
mantenibilidad

Antes de escribir codigo

Siempre, en este orden (RFC-0001 §13):

Explicar el concepto.
Explicar el problema.
Comparar alternativas.
Justificar la implementacion.

Codigo

Conforme a RFC-0001 §13:

Rust idiomatico
Clippy limpio y rustfmt sin diffs
Sin unsafe salvo justificacion documentada (comentario SAFETY)
Comentarios donde aporten valor

Documentacion

Todo capitulo sigue las doce secciones de RFC-0001 §14 y la plantilla de §16. Toda nueva funcionalidad incluye:

README actualizado
Diagramas Mermaid (RFC-0001 §12)
Ejemplos ejecutables
Tests
Benchmarks (si aplica; si no aplica, se declara)

Nunca

Agregar dependencias innecesarias.
Optimizar prematuramente.
Duplicar codigo.
Omitir documentacion.
Publicar capitulos parciales.

Filosofia

Este repositorio debe poder utilizarse como un libro de ingenieria. Nunca sacrificar claridad por ingenio. Explicar el porque, no solo el como.