Logo StartupKit
DE

GitHub Template-Repository einrichten

So konfigurieren Sie ein GitHub Template-Repository für Code-Aufgaben-Phasen und wie Prüfer Zugriff auf Kandidaten-Repositories erhalten.

GitHub Template-Repository einrichten

Code-Aufgaben-Phasen erstellen für jeden Kandidaten ein privates GitHub-Repository aus einem Template-Repository. Diese Anleitung beschreibt, wie Sie Ihr Template-Repository korrekt konfigurieren.

Was ist ein Template-Repository?

Template-Repositories ermöglichen es, neue Repositories mit derselben Verzeichnisstruktur und denselben Dateien zu generieren. Wenn ein Kandidat eine Code-Aufgaben-Phase erreicht, erstellt Kit über die GitHub-API eine neue private Kopie Ihres Template-Repositorys.

Wichtig: Das Quell-Repository muss auf GitHub explizit als Template markiert sein. Ein reguläres Repository kann nicht als Template verwendet werden; die GitHub-API lehnt die Anfrage ab.

So markieren Sie ein Repository als Template

  1. Navigieren Sie zu Ihrem Repository auf GitHub
  2. Klicken Sie auf Settings (Zahnrad-Symbol in der Repository-Navigation)
  3. Unter General finden Sie den Abschnitt Template repository nahe dem Seitenanfang
  4. Aktivieren Sie das Kontrollkästchen Template repository
  5. Klicken Sie auf Save changes (die Einstellung wird sofort wirksam)

Sobald die Option aktiviert ist, zeigt GitHub ein „Template“-Badge auf der Repository-Seite an.

Anforderungen: Checkliste

Anforderung Details
GitHub App installiert Ihre Organisation muss die Kit GitHub App installiert und aktiv haben (Integrationen > GitHub)
Repository existiert Das in der Phasenkonfiguration angegebene org/repo muss auf GitHub existieren
Als Template markiert Im Repository muss unter Settings > General die Option „Template repository“ aktiviert sein
App hat Zugriff Die Kit GitHub App-Installation muss Zugriff auf das Template-Repository haben
Organisation stimmt überein Die GitHub App-Installation muss die Organisation abdecken, in der Kandidaten-Repositories erstellt werden
Prüfer verbunden Jeder der Phase zugewiesene Prüfer muss sein eigenes GitHub-Konto in Kit verbinden, sonst erhält er keinen Zugriff auf Kandidaten-Repositories (siehe Prüferzugriff auf Kandidaten-Repositories)

Das Template in Kit konfigurieren

  1. Navigieren Sie zu Ihrer Stellenanzeige > Phasen
  2. Wählen oder erstellen Sie eine Code-Aufgaben-Phase
  3. Wählen Sie im Feld GitHub Template ein Repository aus dem Dropdown oder geben Sie den org/repo-Namen ein
  4. Das Dropdown zeigt nur Repositories an, die bereits als Template markiert sind. Falls Ihr Repository nicht erscheint, überprüfen Sie, ob es auf GitHub als Template markiert ist
  5. Speichern Sie die Phasenkonfiguration

Kit validiert nach dem Speichern automatisch, ob das Repository ein gültiges Template ist. Bei Problemen erscheint eine Warnung auf der Phasenkarte.

Prüferzugriff auf Kandidaten-Repositories

Kandidaten-Repositories sind privat. Reicht ein Kandidat ein, lädt Kit die zugewiesenen Prüfer der Phase mit Lesezugriff in sein Repository ein, und zwar über den persönlichen GitHub-Handle jedes Prüfers. Kit kennt diesen Handle nur, wenn der Prüfer sein eigenes GitHub-Konto in Kit verbunden hat.

Important

Drei GitHub-Dinge lassen sich leicht verwechseln. Nur das dritte gibt einem Prüfer Zugriff auf Code.

Verbindung Wer sie herstellt Was sie bringt
Organisationsverbindung unter Integrationen > GitHub Ein Admin, einmal pro Konto Kit kann Kandidaten-Repositories aus Ihrem Template erstellen
Mitgliedschaft in der GitHub-Organisation auf GitHub selbst Ein Inhaber der GitHub-Organisation Nichts in Kit. Einen Prüfer in Ihre GitHub-Organisation einzuladen gibt ihm keinen Zugriff auf Kandidaten-Repositories
Persönliche GitHub-Verbindung unter Einstellungen > Verbundene Konten Jeder Prüfer, einmal pro Person Kit kann diesen Prüfer in Kandidaten-Repositories einladen

Ihre Organisation kann vollständig verbunden sein, und trotzdem kann keiner Ihrer Prüfer ein einziges Kandidaten-Repository öffnen.

Prüfer: GitHub einmal verbinden

  1. Öffnen Sie Einstellungen > Verbundene Konten
  2. Klicken Sie unter Anbieter verbinden auf GitHub
  3. Autorisieren Sie Kit auf GitHub

Das ist alles, einmal pro Person. Von da an lädt Kit Sie zu Kandidaten-Repositories ein, sobald Einreichungen eingehen, und holt die verpassten nach: Im Moment der Verbindung gewährt Kit Ihnen Zugriff auf jedes Code-Aufgaben-Repository, das Ihnen bereits zugestanden hätte. Niemand muss eine Phase wiederholen oder eine Einladung erneut senden.

Wenn Sie zum ersten Mal als Prüfer einer Code-Aufgaben-Phase hinzugefügt werden, schickt Kit Ihnen eine Willkommens-E-Mail. Ist Ihr GitHub-Konto noch nicht verbunden, beginnt diese E-Mail mit einer Schaltfläche GitHub verbinden.

Admins: Fehlende Prüfer finden

Kit weist auf die Lücke hin, bevor ein Kandidat überhaupt einreicht:

  • Der Abschnitt Prüfer der Phase zeigt eine gelbe Warnung, die genau benennt, welche Prüfer kein GitHub-Konto verbunden haben.
  • Die Phase trägt in der Phasenliste ein Warnsymbol, und die Stellenanzeige zählt sie in ihrer Zusammenfassung Einrichtung erforderlich mit.
  • Reicht ein Kandidat ein, während ein Prüfer noch nicht verbunden ist, benachrichtigt Kit diesen Prüfer und die Phasenverantwortlichen per E-Mail und in der App.

Niemand kann das für den Prüfer erledigen, weder Sie noch ein Inhaber der GitHub-Organisation. Bitten Sie jeden genannten Prüfer, die drei Schritte oben auszuführen, oder weisen Sie die Bewertung jemandem zu, der bereits verbunden ist.

Best Practices für Template-Repositories

  • Fügen Sie eine aussagekräftige README hinzu mit Aufgabenstellung, Erwartungen und Abgaberichtlinien
  • Fügen Sie eine .gitignore hinzu, die zur verwendeten Sprache und zum Framework passt
  • Stellen Sie Starter-Code bereit oder ein Grundgerüst, auf dem Kandidaten aufbauen können
  • Halten Sie es minimal: Nehmen Sie nur das auf, was Kandidaten zum Einstieg benötigen
  • Fügen Sie eine CI-Konfiguration hinzu (GitHub Actions), wenn Sie automatisierte Tests für Kandidaten-Einreichungen wünschen
  • Keine Secrets, API-Schlüssel oder proprietären Code einbinden

Fehlerbehebung

Problem Ursache Lösung
Kandidat bleibt beim Spinner „Setting Up“ hängen Template-Repository ist nicht als Template markiert Navigieren Sie zu Settings > General des Repositorys und aktivieren Sie „Template repository“
Fehler „Setup encountered an issue“ Template-Repository nicht gefunden oder kein Template Überprüfen Sie, ob das Repository existiert und als Template markiert ist, und lösen Sie die Einrichtung erneut aus
Template-Repository fehlt im Dropdown Repository ist nicht als Template markiert Markieren Sie es in den GitHub-Einstellungen als Template und laden Sie die Seite neu
Warnung „GitHub App not installed“ Keine aktive GitHub-Verbindung Installieren Sie die Kit GitHub App über die Integrationseinstellungen
Warnung „GitHub template repository not set“ Das Feld github_template ist leer Wählen Sie ein Template in der Phasenkonfiguration aus
Kandidat kann nicht auf sein Repository zugreifen GitHub-Einladung wurde nicht gesendet oder nicht angenommen Überprüfen Sie den GitHub-Benutzernamen des Kandidaten und den Status der Repository-Einladung
Prüfer kann das Repository eines Kandidaten nicht öffnen Dieser Prüfer hat kein persönliches GitHub-Konto in Kit verbunden Bitten Sie ihn, GitHub unter Einstellungen > Verbundene Konten zu verbinden; der Zugriff auf die verpassten Repositories wird danach automatisch gewährt
Prüfer ist in unserer GitHub-Organisation, hat aber trotzdem keinen Zugriff Die Mitgliedschaft in der Organisation ist nicht dasselbe wie das Verbinden von GitHub in Kit Dieselbe Lösung: Der Prüfer verbindet GitHub in Kit selbst
Auf GitHub installiert, in Kit aber nicht verbunden Die App ist in Ihrer Organisation angekommen, aber GitHub hat nie bestätigt, dass Sie Inhaber sind; die Installation wartet noch Öffnen Sie Integrationen > GitHub, wählen Sie Verbindung abschließen und danach Auf GitHub bestätigen
Warten auf einen Inhaber der Organisation Sie sind kein Inhaber der Organisation, daher hat GitHub die Installation einem Inhaber zur Genehmigung vorgelegt Bitten Sie einen Inhaber, die Kit GitHub App auf GitHub zu genehmigen, und starten Sie danach erneut GitHub App installieren

Siehe auch

Suchbegriff eingeben...