Skip to content

Commit d7ad742

Browse files
eucyteucyt
authored
Improve issue triage and issue template (#812)
Related to line/line-bot-sdk-ruby#597 - [x] create untriaged label
1 parent 107447f commit d7ad742

File tree

6 files changed

+99
-41
lines changed

6 files changed

+99
-41
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
---
2-
name: Bug Report
3-
about: Create a bug report
4-
labels: bug
5-
2+
name: Bug Report Template
3+
about: Use this template to report bugs in the line-bot-sdk-python
4+
title: 'Bug Report'
65
---
76

8-
## Do this before creating an issue
9-
<!-- Delete this section before the submit -->
10-
11-
- 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
12-
13-
## When creating an issue
14-
<!-- Delete this section before the submit -->
15-
16-
- 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/
17-
- Provide detailed information about the issue you had with the SDK as below
18-
19-
## System Informations
7+
<!--
8+
## Before Creating an Issue
9+
- Please check our [developer documentation](https://developers.line.biz/en/docs/) and [FAQ](https://developers.line.biz/en/faq/tags/messaging-api/) for more information on the Messaging API
10+
- Make sure the issue you are reporting isn't already addressed in the documentation or existing issues.
11+
## When Creating an Issue
12+
- Provide detailed information about the issue you experienced with the SDK using the template below.
13+
-->
2014

21-
* Python version:
22-
* SDK version:
23-
* OS:
15+
## System Information
16+
- Python version:
17+
- line-bot-sdk-python version:
18+
- OS (and version):
19+
- Any other relevant environment details (e.g. Framework version, hosting service, etc.):
2420

2521
## Expected Behavior
26-
<!-- Tell us what should happen -->
22+
<!-- Describe what you expected to happen -->
2723

2824
## Current Behavior
29-
<!-- Tell us what happens instead of the expected behavior -->
25+
<!-- Describe what actually happened instead of the expected behavior -->
3026

3127
## Steps to Reproduce
32-
<!-- Provide a link to a live example, or an unambigeous set of steps to -->
33-
1.
34-
1.
35-
1.
28+
<!-- Provide a link to a live example or a clear set of steps to reproduce the issue.
29+
If possible, provide minimal code (e.g. test code, a draft PR, or a link to a forked repository). -->
3630
1.
31+
2.
32+
3.
3733

3834
## Logs
39-
<!-- Provide logs if possible -->
35+
<!-- If possible, provide logs to help identify the issue -->
36+
37+
## Additional Context (Optional)
38+
<!-- Add any other context or information that might be relevant to the issue.
39+
For example, related issues, potential causes, or possible solutions. -->

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
name: "Documentation"
33
about: Report an issue related to README.md or https://line-bot-sdk-python.readthedocs.io
4-
labels: ''
5-
4+
title: "Documentation Issue"
65
---
76

87
## Documentation

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
name: Feature Request
33
about: Suggest an idea for this project
4-
labels: enhancement
5-
4+
title: 'Feature Request'
65
---
76

87
## Do this before creating an issue

‎.github/ISSUE_TEMPLATE/questions.md‎

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,44 @@
11
---
2-
name: Questions
3-
about: Ask questions related to the LINE Bot SDK.
4-
labels: question
5-
2+
name: "Question Template"
3+
about: "Use this template to ask questions about usage or implementation of the line-bot-sdk-python."
4+
title: "Question"
65
---
76

8-
## Do this before creating an issue
9-
<!-- Delete this section before the submit -->
7+
<!--
8+
## Before Creating a Question Issue
9+
- Please check the [developer documentation](https://developers.line.biz/en/docs/) and [FAQ](https://developers.line.biz/en/faq/tags/messaging-api/) for answers to common questions.
10+
- Make sure your question hasn't already been asked in other Issues or the documentation.
11+
## This Is Not
12+
- A bug report. If you think you've found a bug, please use the "Bug Report" template.
13+
- A place to request new features. If you have a feature request, consider opening a "Feature Request" issue or PR.
14+
## When Creating a Question
15+
- Provide detailed information about your environment and context so we can better understand and answer your question.
16+
- Let us know what you've tried so far (e.g. searching docs, existing issues, etc.).
17+
-->
18+
19+
## Have You Checked the Following?
20+
- [ ] [SDK Document](https://line-bot-sdk-python.readthedocs.io/en/latest/)
21+
- [ ] [Examples](https://github.com/line/line-bot-sdk-python/tree/master/examples/)
22+
- [ ] [Developer Documentation - LINE Developers](https://developers.line.biz/en/docs/)
23+
- [ ] [FAQ - LINE Developers](https://developers.line.biz/en/faq/tags/messaging-api/)
24+
25+
## Summary of Your Question
26+
<!-- Provide a clear and concise description of what you want to know. -->
27+
28+
## Details
29+
<!-- Provide any code snippets, relevant logs, or background details that will help us understand your question better. -->
1030

11-
- 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
31+
## What You've Tried
32+
<!-- Let us know any steps you've already taken to answer your own question,
33+
such as searching in documentation or checking existing issues. -->
1234

13-
## When creating an issue
14-
<!-- Delete this section before the submit -->
35+
## Your Environment
36+
<!-- For example:
37+
- Python version:
38+
- line-bot-sdk-python version:
39+
- OS (and version):
40+
- Any other relevant environment details (e.g. Framework version, hosting service, etc.):
41+
-->
1542

16-
- 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/
43+
## Additional Context (Optional)
44+
<!-- Add any other context, possible considerations, or related links here. -->

‎.github/workflows/close-issue.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
days-before-issue-close: 0
2020
stale-issue-label: "no-activity"
2121
close-issue-message: "This issue was closed because it has been inactive for 14 days."
22-
exempt-issue-labels: "bug,enhancement,keep"
22+
exempt-issue-labels: "bug,enhancement,keep,untriaged"
2323
days-before-pr-stale: -1
2424
days-before-pr-close: 14
2525
stale-pr-label: "no-activity"

‎.github/workflows/label-issue.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Label issue
2+
3+
on:
4+
issues:
5+
types:
6+
- opened
7+
- reopened
8+
- closed
9+
10+
jobs:
11+
label-issues:
12+
runs-on: ubuntu-latest
13+
permissions:
14+
issues: write
15+
steps:
16+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
17+
18+
- name: Add label on issue open
19+
if: github.event.action == 'opened' || github.event.action == 'reopened'
20+
run: |
21+
gh issue edit ${{ github.event.issue.number }} \
22+
--add-label "untriaged" \
23+
env:
24+
GH_TOKEN: ${{ github.token }}
25+
26+
- name: Remove label on issue close
27+
if: github.event.action == 'closed'
28+
run: |
29+
gh issue edit ${{ github.event.issue.number }} \
30+
--remove-label "untriaged"
31+
env:
32+
GH_TOKEN: ${{ github.token }}

0 commit comments

Comments
 (0)