Konfiguracja szablonowego repozytorium GitHub
Jak skonfigurować szablonowe repozytorium GitHub dla etapów zadań programistycznych oraz jak recenzenci uzyskują dostęp do repozytoriów kandydatów.
Konfiguracja szablonowego repozytorium GitHub
Etapy zadań programistycznych tworzą prywatne repozytorium GitHub dla każdego kandydata na podstawie szablonowego repozytorium. Ten przewodnik opisuje, jak prawidłowo skonfigurować szablonowe repozytorium.
Czym jest szablonowe repozytorium?
Z szablonowego repozytorium powstają nowe repozytoria z taką samą strukturą katalogów i plikami. Gdy kandydat dotrze do etapu zadania programistycznego, Kit korzysta z API GitHub, aby utworzyć nową prywatną kopię szablonowego repozytorium.
Ważne: Repozytorium źródłowe musi być jawnie oznaczone jako szablon na GitHub. Zwykłe repozytorium nie może być użyte jako szablon. API GitHub odrzuci takie żądanie.
Jak oznaczyć repozytorium jako szablon
- Przejdź do swojego repozytorium na GitHub
- Kliknij Settings (ikona zębatki w nawigacji repozytorium)
- W sekcji General znajdź Template repository w górnej części strony
- Zaznacz pole Template repository
- Kliknij Save changes (ustawienie działa natychmiast)
Po włączeniu GitHub wyświetli plakietkę „Template” na stronie repozytorium.
Lista kontrolna wymagań
| Wymaganie | Szczegóły |
|---|---|
| Zainstalowana aplikacja GitHub | W twojej organizacji Kit GitHub App musi być zainstalowana i aktywna (Integracje > GitHub) |
| Repozytorium istnieje | Repozytorium org/repo podane w konfiguracji etapu musi istnieć na GitHub |
| Oznaczone jako szablon | Repozytorium musi mieć zaznaczoną opcję „Template repository” w Settings > General |
| Aplikacja ma dostęp | Instalacja Kit GitHub App musi mieć dostęp do szablonowego repozytorium |
| Zgodność organizacji | Instalacja GitHub App musi obejmować organizację, w której będą tworzone repozytoria kandydatów |
| Połączenie recenzentów | Każdy recenzent przypisany do etapu musi połączyć osobiste konto GitHub w Kit. Zobacz Dostęp recenzentów do repozytoriów kandydatów |
Konfiguracja szablonu w Kit
- Przejdź do Job Posting > Stages
- Wybierz lub utwórz etap Code Assignment
- W polu GitHub Template wybierz repozytorium z listy rozwijanej lub wpisz nazwę w formacie
org/repo - Lista rozwijana pokazuje tylko repozytoria oznaczone jako szablony. Jeśli repozytorium nie pojawia się na liście, sprawdź, czy jest oznaczone jako szablon na GitHub
- Zapisz konfigurację etapu
Po zapisaniu Kit automatycznie zweryfikuje, czy repozytorium jest prawidłowym szablonem. W przypadku problemu na karcie etapu pojawi się ostrzeżenie.
Dostęp recenzentów do repozytoriów kandydatów
Repozytoria kandydatów są prywatne. Po przesłaniu zadania Kit zaprasza przypisanych do etapu recenzentów z uprawnieniami do odczytu. Korzysta z osobistej nazwy użytkownika GitHub każdego recenzenta, dostępnej dopiero po połączeniu jego konta GitHub z Kit.
Important
Połączenie organizacji z GitHub nie zastępuje osobistego połączenia recenzenta.
| Połączenie | Kto je konfiguruje | Do czego służy |
|---|---|---|
| Połączenie organizacji w Integracje > GitHub | Administrator, raz dla konta | Pozwala Kit tworzyć repozytoria kandydatów z szablonu |
| Członkostwo w organizacji GitHub, na stronie GitHub | Właściciel organizacji GitHub | Samo w sobie nie daje w Kit dostępu do repozytoriów kandydatów |
| Osobiste połączenie GitHub w Ustawienia > Połączone konta | Każdy recenzent osobno | Pozwala Kit zapraszać tego recenzenta do repozytoriów kandydatów |
Recenzenci: połączcie konto GitHub
- Otwórz Ustawienia > Połączone konta.
- W sekcji Connect a Provider (połącz dostawcę) kliknij GitHub.
- Zatwierdź dostęp Kit na GitHub.
Wystarczy zrobić to raz. Kit będzie zapraszać cię do repozytoriów po przesłaniu zadań, a po połączeniu nada też dostęp do wcześniejszych repozytoriów, do których masz uprawnienia. Nie trzeba powtarzać etapu ani ponownie wysyłać zaproszenia.
Przy pierwszym przypisaniu do etapu zadania programistycznego dostaniesz wiadomość powitalną. Jeśli nie masz jeszcze połączonego konta GitHub, znajdziesz w niej przycisk Connect GitHub (połącz GitHub).
Administratorzy: sprawdźcie brakujące połączenia
Kit pokazuje brak połączenia jeszcze przed przesłaniem zadania:
- Sekcja Reviewers (recenzenci) na etapie wyświetla bursztynowe ostrzeżenie z nazwiskami osób, które nie połączyły GitHub.
- Na liście etapów pojawia się ikona ostrzeżenia, a ogłoszenie uwzględnia ten etap w podsumowaniu needs setup (wymaga konfiguracji).
- Jeśli kandydat prześle zadanie przed połączeniem GitHub przez recenzenta, Kit powiadomi tego recenzenta oraz osoby prowadzące etap e-mailem i w aplikacji.
Każdy recenzent musi połączyć swoje konto samodzielnie. Poproś wskazane osoby o wykonanie trzech kroków powyżej albo przypisz ocenę komuś, kto ma już połączenie.
Dobre praktyki dla szablonowych repozytoriów
- Dołącz czytelny README z instrukcjami zadania, oczekiwaniami i wytycznymi dotyczącymi przesyłania rozwiązania
-
Dodaj plik
.gitignoreodpowiedni dla danego języka programowania i frameworka - Dołącz kod startowy lub szablon bazowy, na którym kandydaci mogą budować rozwiązanie
- Ogranicz zawartość do minimum: umieść tylko to, czego kandydaci potrzebują na start
- Dodaj konfigurację CI (GitHub Actions), jeśli chcesz uruchamiać automatyczne testy na rozwiązaniach kandydatów
- Nie umieszczaj sekretów, kluczy API ani zastrzeżonego kodu
Rozwiązywanie problemów
| Problem | Przyczyna | Rozwiązanie |
|---|---|---|
| Kandydat widzi stale wskaźnik postępu „Setting Up” | Repozytorium nie jest oznaczone jako szablon | Przejdź do Settings > General repozytorium i zaznacz „Template repository” |
| Błąd „Setup encountered an issue” | Repozytorium szablonowe nie zostało znalezione lub nie jest szablonem | Sprawdź, czy repozytorium istnieje i jest oznaczone jako szablon, a następnie ponownie uruchom konfigurację |
| Repozytorium szablonowe nie pojawia się na liście | Repozytorium nie jest oznaczone jako szablon | Oznacz je jako szablon w ustawieniach GitHub, a następnie odśwież stronę |
| Ostrzeżenie „GitHub App not installed” | Brak aktywnego połączenia z GitHub | Zainstaluj Kit GitHub App w ustawieniach Integracji |
| Ostrzeżenie „GitHub template repository not set” | Pole github_template jest puste |
Wybierz szablon w konfiguracji etapu |
| Kandydat nie ma dostępu do repozytorium | Zaproszenie GitHub nie zostało wysłane lub zaakceptowane | Sprawdź nazwę użytkownika GitHub kandydata i status zaproszenia do repozytorium |
| Recenzent nie może otworzyć repozytorium kandydata | Nie ma osobistego połączenia GitHub w Kit | Poproś o połączenie w Ustawienia > Połączone konta. Dostęp do wcześniejszych repozytoriów zostanie nadany automatycznie |
| Recenzent jest członkiem organizacji GitHub, ale nadal nie ma dostępu | Członkostwo w organizacji nie zastępuje osobistego połączenia w Kit | Recenzent musi samodzielnie połączyć GitHub w Kit |
| Zainstalowana na GitHub, ale niepołączona w Kit | Aplikacja trafiła do twojej organizacji, ale GitHub nigdy nie potwierdził, że jesteś właścicielem tej organizacji, więc instalacja wciąż czeka | Otwórz Integracje > GitHub, wybierz Dokończ łączenie, a potem Potwierdź w GitHub |
| Instalacja czeka na właściciela organizacji | Nie jesteś właścicielem organizacji, więc GitHub przekazał instalację właścicielowi do zatwierdzenia | Poproś właściciela, aby zatwierdził Kit GitHub App, a potem ponownie uruchom Zainstaluj aplikację GitHub |
Zobacz także
- Konfiguracja szablonu procesu: konfiguracja YAML dla etapów zadań programistycznych
- Oceny i informacje zwrotne: przypisywanie recenzentów, powiadomienia i głosowanie na etapie
- Dokumentacja szablonowych repozytoriów GitHub