GitHub – szablony dla Issue i Pull Request

Ciekawą funkcją GitHuba – szczególnie przydatną w przypadku wieloosobowych zespołów są szablony dla nowo tworzonych Pull Requestów lub Issue.

Jeśli zależy nam na fajnej kulturze pracy z kodem możemy sobie takie szablony zaaplikować w swoich repozytoriach i na szczęście nie jest to skomplikowane i kończy się w momencie utworzenia plików o odpowiednich nazwach: issue_template.md oraz pull_request_template.md, na przykład w katalogu .github, który także tworzymy w naszym projekcie.

Jak widać po rozszerzeniu, pliki te to po prostu najzwyklejsze dokumenty Markdown, więc w ich treść można wrzucić wszystko, co Markdown jest w stanie obsłużyć: nagłówki, pogrubienie tekstu, kursywę, dowolne typy list, kawałki kodu czy co najfajniejsze – pola do zaznaczenia.

Prosty Issue Template:

✔️ Expected Behavior

✅ Actual Behavior

Steps to Reproduce the Problem

Specifications

• Version:
• Platform:
• Subsystem:

view raw

issue_template.md

hosted with ❤ by GitHub

oraz Pull Request Template:

Fixes #

• Something here
• Finished there

Proposed Changes

view raw

pull_request_template.md

hosted with ❤ by GitHub

W przypadku automatyzacji Pull Requestów można nasz szablon rozdzielić na kilka różnych plików i przekazując odpowiednie parametry w adresie – sterować wybieranym szablonem. Szczegóły można znaleźć na w dokumentacji GitHub.

Więcej przykładów oraz informacji znaleźć można w następujących repozytoriach: github-issue-templates i awesome-github-templates.