Skopiuj i dostosuj szablon zasad współtworzenia
Zastąp pola zastępcze i sprawdź każde polecenie oraz link. Przyjmuj poprawki dokumentacji i raporty błędów także od osób, które nie są jeszcze gotowe zmieniać kodu aplikacji.
# Współtworzenie
## Zanim zaczniesz
Przeczytaj README i sprawdź istniejące zgłoszenia.
Duże zmiany omów przed rozpoczęciem implementacji.
## Konfiguracja lokalna
[Wymagane środowisko i sprawdzone polecenia konfiguracji]
## Zgłoszenie błędu
Podaj wersję, środowisko, kroki, oczekiwany i rzeczywisty wynik.
Usuń z logów sekrety i dane osobowe.
## Pull request
- Wyjaśnij problem i proponowaną zmianę.
- Zachowaj skupiony zakres zmiany.
- Uruchom [kontrole wymagane w projekcie].
- Uaktualnij odpowiednią dokumentację.
## Przegląd
[Kto sprawdza, jak odpowiadać i rzeczywista dostępność]
## Inne sposoby pomocy
[Dokumentacja, przykłady, tłumaczenia lub odtwarzalne zgłoszenia]Ułatw znalezienie zasad
GitHub rozpoznaje zasady współtworzenia w katalogu głównym repozytorium, docs lub .github. Dodaj też link z README, aby osoba czytająca wprowadzenie od razu znalazła opis procesu.
Sprawdź ścieżkę z rzeczywistych miejsc rozpoczęcia współpracy w repozytorium. Jeśli istnieje kilka plików z zasadami, usuń sprzeczności. Współtwórca nie powinien znajdować jednego polecenia konfiguracji w README i innego, nieobsługiwanego w poradniku współpracy.
Zaprojektuj przystępny pierwszy wkład
Wybierz małe zadanie z jasnym wynikiem, na przykład poprawienie przykładu dla obsługiwanej wersji środowiska. Wyjaśnij odtworzenie problemu, oczekiwaną zmianę zachowania i sposób sprawdzenia ukończenia. Nie oznaczaj zadania jako przyjaznego początkującym, jeśli wymaga nieudokumentowanej wiedzy wewnętrznej.
Rzetelnie określ dostępność do przeglądu. Jeśli nie możesz obiecać terminu odpowiedzi, wyjaśnij zamiast tego, jak sprawdzić stan zgłoszenia. Jasne granice ograniczają porzuconą pracę i są użyteczniejsze niż obietnica scalenia każdego wkładu.
Częste pytania
Czy CONTRIBUTING.md zastępuje README.md?
Nie. README wyjaśnia projekt i sposób użycia. Zasady współtworzenia opisują proponowanie i sprawdzanie zmian.
Czy skopiować polecenia testowe z innego projektu?
Tylko jeśli są też poprawne dla Twojego projektu. Zastąp pola poleceniami, które rzeczywiście sprawdzono.
Czy zasady współtworzenia gwarantują więcej współtwórców?
Nie. Zmniejszają niepewność zainteresowanych osób, ale nadal liczą się przydatność projektu, jakość zadań i zaangażowanie opiekuna.