From c42b1c685447f504ab5fc5d45d24bc6a39d30e34 Mon Sep 17 00:00:00 2001 From: Laurence Young Date: Tue, 3 Nov 2026 16:21:58 +0800 Subject: [PATCH 1/2] docs: add issue and pull request templates --- .github/ISSUE_TEMPLATE/bug.yml | 37 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature.yml | 30 ++++++++++++++++++++++++ .github/pull_request_template.md | 25 ++++++++++++++++++++ 4 files changed, 93 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..6de4d94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,37 @@ +name: Bug report +description: Report a defect in English. +title: "" +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Write in English. Do not include secrets, credentials, or private URLs. + - type: textarea + id: context + attributes: + label: Context + description: What were you doing? Include the version, commit, or environment. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected + description: What did you expect to happen? + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual + description: What happened instead? + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Reproduce + description: Exact steps, commands, or a minimal reproduction. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..ca1e57d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,30 @@ +name: Feature request +description: Propose a change in English. +title: "" +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Write in English. Describe the problem before the solution. + - type: textarea + id: problem + attributes: + label: Problem + description: What problem are you trying to solve? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposal + description: What should change? + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: What else did you consider? + validations: + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..6e1d23b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,25 @@ +## Summary + +What changes and why. Write in English. + +## Changes + +- concrete edit +- concrete edit + +## Testing + +The exact commands run and their result. + +## Issues + +Closes #123 + +## Checklist + +- [ ] The title follows Conventional Commits and matches the commit subject. +- [ ] The body is written in English. +- [ ] Tests were run and the result is stated above. +- [ ] Human-facing documents are paired with `.zh-CN.md` and open with the language switcher. +- [ ] No secrets, credentials, or private URLs are included. +- [ ] `Closes` is used only when the pull request fully resolves the issue. From 69a688ac91d899a6d01b90ada44edfdfa03b6ae1 Mon Sep 17 00:00:00 2001 From: Laurence Young Date: Tue, 3 Nov 2026 16:21:58 +0800 Subject: [PATCH 2/2] ci: name the test check --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 219d64c..c42e374 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -34,6 +34,7 @@ concurrency: jobs: test: + name: test runs-on: ubuntu-22.04 steps: - name: Checkout Code