Manual do desenvolvedor¶
Este manual é direcionado a dois públicos: contribuidores do código gitrust (core ou via fork Rustwarden) e desenvolvedores externos que constroem integrações na API pública. Ele fornece tudo o que é necessário para entender a arquitetura das 6 caixas, contribuir com código em conformidade com os padrões do projeto ou construir um cliente que se comunique com a API gitrust. Não cobre a instalação de uma instância de produção nem o uso diário da forja.
Caminho de aprendizagem – contribuidor principal¶
O curso de contribuidor representa aproximadamente 4 horas no total, com suporte decrescente: o primeiro tutorial é totalmente guiado, o terceiro (capstone) requer resolução sem passo a passo.
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.
Tutoriais - aprenda fazendo¶
Os tutoriais são guiados passo a passo com o resultado literal esperado. Siga-os em ordem – cada um assume que o anterior foi concluído.
- 01 — Primeiros passos: construção local, testes, instância de desenvolvimento — ~45 min
- 02 — Primeira contribuição: clonar, construir, testar, PR — ~90 min
- 03 — Crie um trabalhador assíncrono (capstone) — ~120 min
Como fazer — receitas para tarefas comuns¶
Os procedimentos respondem “como fazer X” sem qualquer explicação substantiva. Visualize-os em qualquer ordem, conforme necessário.
- Fluxo de trabalho de contribuição: Git + revisão + controle de qualidade
- Iniciar testes unitários
- Iniciar testes E2E (Dramaturgo)
- Adicionar uma rota da web (padrão Rustwarden → axum)
- Adicionar um serviço comercial
- Adicionar uma migração de banco de dados
- Implementar webhooks
- Implementar um endpoint de API
- Importar um repositório externo (código)
- Contribua para o upstream do Rustwarden
- Passe o controle de qualidade antes da mesclagem
Referência – informações técnicas exatas¶
A referência documenta de forma abrangente a arquitetura, APIs internas, esquema de dados e regras de controle de qualidade. Destinado a consultas ocasionais.
- Arquitetura das 6 caixas
- Serviços e API interna
- Esquema de banco de dados (ERD)
- Regras de controle de qualidade e portas ANSSI
- API REST v1 — autenticação, paginação, códigos de erro
- Git hooks pós-recebimento
- API Rustwarden-core — ajudantes, extratores, middleware
Explicação – entenda o porquê¶
As explicações constroem os modelos mentais necessários para contribuir de forma informada. Leia-os quando quiser entender as decisões arquitetônicas, e não apenas aplicá-las.