manual del desarrollador¶
Este manual está dirigido a dos audiencias: contribuyentes al código gitrust (central o mediante fork rustwarden) y desarrolladores externos que crean integraciones en la API pública. Proporciona todo lo necesario para comprender la arquitectura de las 6 cajas, contribuir con código que se ajuste a los estándares del proyecto o crear un cliente que se comunique con la API de gitrust. No cubre la instalación de una instancia de producción ni el uso diario de la fragua.
Ruta de aprendizaje: colaborador principal¶
El curso para colaboradores representa aproximadamente 4 horas en total, con soporte decreciente: el primer tutorial es completamente guiado, el tercero (capstone) requiere resolución sin guía paso a paso.
graph LR
A[Utilisateur autonome] --> B[01-getting-started
45 min]
B --> C[02-premiere-contribution
90 min]
C --> D[03-creer-un-worker-async
capstone 120 min]
D --> E[Core contributor]
Checkpoint de parcours : avant de passer au tutoriel 02, vous devez avoir compilé gitrust localement, lancé les tests unitaires et obtenu une instance de développement fonctionnelle. Si ce n'est pas le cas, relisez le tutoriel 01.
Checkpoint de parcours : avant le tutoriel 03 (capstone), vous devez avoir soumis une PR complète avec tests, passé la gate QA et reçu une review. Si ce n'est pas le cas, relisez le tutoriel 02.
Tutoriales: aprende haciendo¶
Los tutoriales se guían paso a paso con el resultado palabra por palabra esperado. Síguelos en orden; cada uno asume que el anterior está completo.
- 01 — Primeros pasos: compilación local, pruebas, instancia de desarrollo — ~45 min
- 02 — Primera contribución: clonar, construir, probar, relaciones públicas — ~90 min
- 03 — Crear un trabajador asíncrono (capstone) — ~120 min
Procedimientos: recetas para tareas comunes¶
Los instructivos responden "cómo hacer X" sin ninguna explicación sustancial. Véalos en cualquier orden según sea necesario.
- Flujo de trabajo de contribución: Git + revisión + control de calidad
- Iniciar pruebas unitarias
- Iniciar pruebas E2E (Dramaturgo)
- Agregar una ruta web (patrón Rustwarden → axum)
- Agregar un servicio empresarial
- Agregar una migración de base de datos
- Implementar webhooks
- Implementar un punto final API
- Importar un repositorio externo (código)
- [Contribuya a Rustwarden Upstream] (how-to/contribute-a-rustwarden.md)
- Pasar control de calidad antes de fusionar
Referencia — información técnica exacta¶
La referencia documenta de forma exhaustiva la arquitectura, las API internas, el esquema de datos y las reglas de control de calidad. Destinado a consultas ocasionales.
- Arquitectura de las 6 cajas
- Servicios y API interna
- Esquema de base de datos (ERD)
- Reglas de control de calidad y puertas ANSSI
- API REST v1: autenticación, paginación, códigos de error
- [Git ganchos después de la recepción] (referencia/git-hooks-post-receive.md)
- API Rustwarden-core: ayudas, extractores, middleware
Explicación: comprenda el por qué¶
Las explicaciones construyen los modelos mentales necesarios para contribuir de manera informada. Léalos cuando quiera comprender las decisiones arquitectónicas, no sólo aplicarlas.
- [descripción general de la arquitectura gitrust] (explicación/vue-ensemble-architecture.md)
- Flujo de consultas (diagramas de secuencia)
- Modelo de permisos RBAC de 4 niveles
- Cómo funciona 2FA
- Jerarquía de etiquetas
- [CI Dagger: modo fácil frente a modo de potencia] (explicación/ci-dagger-easy-vs-power.md)
- Decisiones de UI: HTMX + DaisyUI
- Trabajador patrón asíncrono