Entwicklerhandbuch

Dieses Handbuch richtet sich an zwei Zielgruppen: Mitwirkende an Gitrust-Code (Core oder über Fork Rustwarden) und externe Entwickler, die Integrationen auf der öffentlichen API erstellen. Es bietet alles, was Sie benötigen, um die Architektur der 6 Crates zu verstehen, Code beizutragen, der den Projektstandards entspricht, oder einen Client zu erstellen, der mit der Gitrust-API kommuniziert. Die Installation einer Produktionsinstanz und die tägliche Nutzung der Schmiede sind nicht abgedeckt.

Lernpfad – Hauptmitwirkender

Der Kurs für Mitwirkende dauert insgesamt etwa 4 Stunden, mit abnehmender Unterstützung: Das erste Tutorial ist vollständig geführt, das dritte (Schlussstein) erfordert die Lösung ohne Schritt-für-Schritt-Anleitung.

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.

Tutorials – Lernen durch Handeln

Die Tutorials werden Schritt für Schritt mit der erwarteten wörtlichen Ausgabe geführt. Folgen Sie ihnen der Reihe nach – bei jedem wird davon ausgegangen, dass der vorherige abgeschlossen ist.

How-to – Rezepte für häufige Aufgaben

Anleitungen beantworten „wie man X macht“ ohne inhaltliche Erklärung. Zeigen Sie sie nach Bedarf in beliebiger Reihenfolge an.

Referenz – genaue technische Informationen

Die Referenz dokumentiert umfassend die Architektur, interne APIs, Datenschemata und QA-Regeln. Für gelegentliche Beratung gedacht.

Erklärung – verstehen Sie das Warum

Erklärungen bilden die mentalen Modelle, die für einen fundierten Beitrag erforderlich sind. Lesen Sie sie, wenn Sie Architekturentscheidungen verstehen und nicht nur anwenden möchten.