最近開始用 Github 管理專案,也順便開始學習整個 Open Source Project 的運作,
- 所有需求、問題都可以被完整記錄,採用 Issues
- 開放所有人可以參與專案開發,採用 Pull Requests
很快的就遇到狀況,主要是資訊完整性的問題
- Issues 開單的人未能完整描述問題,沒有標準的格式。
- Pull Requests 未清楚交代修改歷程、格式。
找了一下發現 Github 其實早就支援各種 Template「About issue and pull request templates」,主要是在專案目錄內放置 .github 的 Template files.
範例專案可以參考 github.com/shazi7804/github-issue-pull-request-templates
.github
|-- ISSUE_TEMPLATE
| |-- config.yml
| |-- issues.md
| |-- feature.md
`-- PULL_REQUEST_TEMPLATE.md
.github/ISSUE_TEMPLATE/*.md
內可以放各種 Issue templates,讓提問者選擇適合的 template。.github/ISSUE_TEMPLATE/config.yml
用來定義是否開放「空白 issues」提問(blank_issues_enabled).github/PULL_REQUEST_TEMPLATE.md
用來定義 Pull Request 的 template。
一個簡單的 issue template 範例參考;
---
name: Simple Issue
about: Template to simple issue.
---
# Description
?
# Step by Step
?
# Screenshot or more
?
- name, about 會出現在 Get started 的表單中,也可以選擇按 Open a blank issue 要開空白頁