From 614665267adb4b35c1ca6f3a09f2e78ef533e5e8 Mon Sep 17 00:00:00 2001 From: Euchi Yuta Date: Fri, 23 May 2025 18:12:56 +0900 Subject: [PATCH 1/3] Improve issue triage and issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 52 +++++++++++------------ .github/ISSUE_TEMPLATE/documentation.md | 2 - .github/ISSUE_TEMPLATE/feature_request.md | 3 +- .github/ISSUE_TEMPLATE/questions.md | 48 ++++++++++++++++----- .github/workflows/close-issue.yml | 2 +- .github/workflows/label-issue.yml | 32 ++++++++++++++ 6 files changed, 98 insertions(+), 41 deletions(-) create mode 100644 .github/workflows/label-issue.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 43a582ef4..0cb39d523 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,39 +1,39 @@ --- -name: Bug Report -about: Create a bug report -labels: bug - +name: Bug Report Template +about: Use this template to report bugs in the line-bot-sdk-python +title: 'Bug Report' --- -## Do this before creating an issue - - -- Check our [developers documentation](https://developers.line.biz/en/docs/messaging-api/) and [FAQ](https://developers.line.biz/en/faq/) for more information on LINE bots and the Messaging API - -## When creating an issue - - -- Make sure your issue is **related to** the LINE Bot SDK. For general questions about LINE bots, please ask in https://www.linebiz.com/contact/ -- Provide detailed information about the issue you had with the SDK as below - -## System Informations + -* Python version: -* SDK version: -* OS: +## System Information +- Python version: +- line-bot-sdk-python version: +- OS (and version): +- Any other relevant environment details (e.g. Framework version, hosting service, etc.): ## Expected Behavior - + ## Current Behavior - + ## Steps to Reproduce - -1. -1. -1. + 1. +2. +3. ## Logs - + + +## Additional Context (Optional) + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index c8f441166..ff16e7146 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -1,8 +1,6 @@ --- name: "Documentation" about: Report an issue related to README.md or https://line-bot-sdk-python.readthedocs.io -labels: '' - --- ## Documentation diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 62c1472fa..fb2011948 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,8 +1,7 @@ --- name: Feature Request about: Suggest an idea for this project -labels: enhancement - +title: 'Feature Request' --- ## Do this before creating an issue diff --git a/.github/ISSUE_TEMPLATE/questions.md b/.github/ISSUE_TEMPLATE/questions.md index 8907324f6..96229d425 100644 --- a/.github/ISSUE_TEMPLATE/questions.md +++ b/.github/ISSUE_TEMPLATE/questions.md @@ -1,16 +1,44 @@ --- -name: Questions -about: Ask questions related to the LINE Bot SDK. -labels: question - +name: "Question Template" +about: "Use this template to ask questions about usage or implementation of the line-bot-sdk-python." +title: "Question" --- -## Do this before creating an issue - + + +## Have You Checked the Following? +- [ ] [SDK Document](https://line-bot-sdk-python.readthedocs.io/en/latest/) +- [ ] [Examples - line-bot-api gem](https://github.com/line/line-bot-sdk-python/tree/master/examples/) +- [ ] [Developer Documentation - LINE Developers](https://developers.line.biz/en/docs/) +- [ ] [FAQ - LINE Developers](https://developers.line.biz/en/faq/tags/messaging-api/) + +## Summary of Your Question + + +## Details + -- Check our [developers documentation](https://developers.line.biz/en/docs/messaging-api/), [FAQ](https://developers.line.biz/en/faq/), and [developers community](https://www.line-community.me/questions) for more information on LINE bots and the Messaging API +## What You've Tried + -## When creating an issue - +## Your Environment + -- Make sure your issue is **related to** the LINE Bot SDK. For general questions about LINE bots, please ask in https://www.linebiz.com/contact/ +## Additional Context (Optional) + \ No newline at end of file diff --git a/.github/workflows/close-issue.yml b/.github/workflows/close-issue.yml index ac4701eef..e9c006b81 100644 --- a/.github/workflows/close-issue.yml +++ b/.github/workflows/close-issue.yml @@ -19,7 +19,7 @@ jobs: days-before-issue-close: 0 stale-issue-label: "no-activity" close-issue-message: "This issue was closed because it has been inactive for 14 days." - exempt-issue-labels: "bug,enhancement,keep" + exempt-issue-labels: "bug,enhancement,keep,untriaged" days-before-pr-stale: -1 days-before-pr-close: 14 stale-pr-label: "no-activity" diff --git a/.github/workflows/label-issue.yml b/.github/workflows/label-issue.yml new file mode 100644 index 000000000..a440f7817 --- /dev/null +++ b/.github/workflows/label-issue.yml @@ -0,0 +1,32 @@ +name: Label issue + +on: + issues: + types: + - opened + - reopened + - closed + +jobs: + label-issues: + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + + - name: Add label on issue open + if: github.event.action == 'opened' || github.event.action == 'reopened' + run: | + gh issue edit ${{ github.event.issue.number }} \ + --add-label "untriaged" \ + env: + GH_TOKEN: ${{ github.token }} + + - name: Remove label on issue close + if: github.event.action == 'closed' + run: | + gh issue edit ${{ github.event.issue.number }} \ + --remove-label "untriaged" + env: + GH_TOKEN: ${{ github.token }} From 99d43458394771b6925cf8c45cc4349d3e2a09e5 Mon Sep 17 00:00:00 2001 From: Euchi Yuta Date: Fri, 23 May 2025 18:15:15 +0900 Subject: [PATCH 2/3] Add title to documentation issue template --- .github/ISSUE_TEMPLATE/documentation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index ff16e7146..1266eb1c5 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -1,6 +1,7 @@ --- name: "Documentation" about: Report an issue related to README.md or https://line-bot-sdk-python.readthedocs.io +title: "Documentation Issue" --- ## Documentation From a3d4fa83477cdc2a139ec33ca9a34e7a802a9cc5 Mon Sep 17 00:00:00 2001 From: Yuta Euchi <63095160+eucyt@users.noreply.github.com> Date: Fri, 23 May 2025 18:19:53 +0900 Subject: [PATCH 3/3] Update questions.md --- .github/ISSUE_TEMPLATE/questions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/questions.md b/.github/ISSUE_TEMPLATE/questions.md index 96229d425..5a058f427 100644 --- a/.github/ISSUE_TEMPLATE/questions.md +++ b/.github/ISSUE_TEMPLATE/questions.md @@ -18,7 +18,7 @@ title: "Question" ## Have You Checked the Following? - [ ] [SDK Document](https://line-bot-sdk-python.readthedocs.io/en/latest/) -- [ ] [Examples - line-bot-api gem](https://github.com/line/line-bot-sdk-python/tree/master/examples/) +- [ ] [Examples](https://github.com/line/line-bot-sdk-python/tree/master/examples/) - [ ] [Developer Documentation - LINE Developers](https://developers.line.biz/en/docs/) - [ ] [FAQ - LINE Developers](https://developers.line.biz/en/faq/tags/messaging-api/) @@ -41,4 +41,4 @@ title: "Question" --> ## Additional Context (Optional) - \ No newline at end of file +