Manuale dello sviluppatore¶
Questo manuale è rivolto a due tipi di pubblico: contributori al codice gitrust (core o tramite fork rugginewarden) e sviluppatori esterni che creano integrazioni sull'API pubblica. Fornisce tutto il necessario per comprendere l'architettura dei 6 crate, contribuire con codice conforme agli standard del progetto o creare un client che parli con l'API gitrust. Non copre l'installazione di un'istanza di produzione né l'uso quotidiano della fucina.
Percorso di apprendimento: collaboratore principale¶
Il corso per contributore rappresenta circa 4 ore in totale, con supporto decrescente: il primo tutorial è interamente guidato, il terzo (capstone) richiede la risoluzione senza una guida passo 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.
Tutorial: impara facendo¶
I tutorial sono guidati passo dopo passo con l'output letterale previsto. Seguiteli in ordine: ognuno presuppone che il precedente sia stato completato.
- 01 — Per iniziare: build locale, test, istanza di sviluppo — ~45 min
- 02 — Primo contributo: clone, build, test, PR — ~90 min
- 03 — Crea un lavoratore asincrono (capstone) — ~120 min
Come fare: ricette per attività comuni¶
Le istruzioni rispondono a "come fare X" senza alcuna spiegazione sostanziale. Visualizzateli in qualsiasi ordine secondo necessità.
- Flusso di lavoro Contribute: Git + revisione + QA
- Avvia unit test
- Avvia test E2E (drammaturgo)
- Aggiungi un percorso web (modello ruggine → axum)
- Aggiungi un servizio aziendale
- Aggiungi una migrazione del database
- Implementare i webhook
- Implementare un endpoint API
- Importare un repository esterno (codice)
- Contribuisci a Rustwarden upstream
- Supera il QA prima dell'unione
Riferimento: informazioni tecniche esatte¶
Il riferimento documenta in modo completo l'architettura, le API interne, lo schema dei dati e le regole di QA. Destinato alla consultazione occasionale.
- Architettura delle 6 casse
- Servizi e API interne
- Schema del database (ERD)
- Regole QA e porte ANSSI
- API REST v1: autenticazione, impaginazione, codici di errore
- Git hooks post-receive
- APIrustwarden-core: aiutanti, estrattori, middleware
Spiegazione: capisci il perché¶
Le spiegazioni costruiscono i modelli mentali necessari per contribuire in modo informato. Leggili quando vuoi comprendere le decisioni architettoniche, non solo applicarle.