Szablon CONTRIBUTING¶
Strona podaje szablon pliku CONTRIBUTING.md repozytorium i mówi, jak go wypełniać.
Jest dla osób, które zakładają repozytorium albo uzupełniają jego zasady pracy.
CONTRIBUTING.md zawiera tylko to, co w danym repozytorium różni się od wspólnego procesu.
Wspólny proces opisuje Proces pracy, więc nie kopiujemy go do repozytoriów.
Dzięki temu zmiana procesu wymaga edycji jednej strony.
Zasady wypełniania¶
| Sekcja | Co zawiera |
|---|---|
| Proces | odsyłacz do strony "Proces pracy" i wyjątki od niej |
| Struktura kodu | katalogi i warstwy, w których powinien się odnaleźć nowy programista |
| Styl kodu | formater, linter i polecenie, które je uruchamia |
| Testy | co jest wymagane przed pull requestem i jak to uruchomić |
| Dokumentacja w kodzie | język komentarzy i odsyłacz do zasad 36–46 |
| Wydanie | jak powstaje wersja, jeśli repozytorium ma własny proces wydawniczy |
Sekcja bez treści dla repozytorium dostaje zdanie "Nie dotyczy.".
Szablon¶
# Jak kontrybuować
## Proces
Branche, commity i pull requesty opisuje strona "Proces pracy" w dokumentacji workspace'u.
Wyjątki dla tego repozytorium: <brak albo opis>.
## Struktura kodu
| Katalog | Zawartość |
|---|---|
| `<katalog>` | <opis> |
## Styl kodu
```bash
<polecenie formatera>
<polecenie lintu>
```
## Testy
```bash
<polecenie testów>
```
Pull request <MUSI albo POWINIEN> przejść testy przed merge.
## Dokumentacja w kodzie
Komentarze dokumentacyjne piszemy po <angielsku albo polsku>.
Wymagania opisują zasady 36–46 w dokumentacji workspace'u.
## Wydanie
<Opis albo "Nie dotyczy.">
Przykład¶
Repozytorium logintegra-toolbox-cli ma własny CONTRIBUTING.md o architekturze poleceń i workflow.
Po wdrożeniu szablonu ta treść zostaje w sekcji "Struktura kodu", a sekcje wspólne wskazują stronę procesu.
Ostatnia zmiana: 2026-10-06 · Dariusz Bakowski
Zbudowano: 2026-11-20 10:32 UTC · wersja 1.0.0 · rewizja: 19fcdc12e