Skip to content

Commit 990cd24

Browse files
eucyteucyt
authored
Improve issue triage and issue template (#1287)
Related to line/line-bot-sdk-ruby#597 - [x] create untriaged label
1 parent 7ed2723 commit 990cd24

File tree

5 files changed

+132
-34
lines changed

5 files changed

+132
-34
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,38 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: '[BUG]'
5-
labels: 'bug'
6-
assignees: 'kawasako'
7-
2+
name: Bug Report Template
3+
about: Use this template to report bugs in the line-bot-sdk-nodejs
4+
title: 'Bug Report'
85
---
96

10-
## Bug Report
11-
<!-- First of all: Have you checked the docs https://developers.line.biz/en/docs/messaging-api/overview/, Q&A page https://developers.line.biz/en/faq/, GitHub issues whether someone else has already reported your issue? -->
12-
13-
**Describe the bug**
14-
A clear and concise description of what the bug is.
15-
16-
**To Reproduce**
17-
<!-- It would be appreciate if you share the minimal complete reproducible Javascript code or Repo link: -->
18-
Steps to reproduce the behavior:
19-
1. use '...' function, pass the '...' parameter.
20-
2. ...
21-
3. ???
22-
4. See error
23-
24-
**Expected behavior**
25-
A clear and concise description of what you expected to happen.
26-
27-
**Screenshots**
28-
If applicable, add screenshots to help explain your problem.
29-
30-
**Environment (please complete the following information):**
31-
- OS: [e.g. Ubuntu]
32-
- Node.js Version [e.g. Node 8]
33-
- line-bot-sdk-nodejs version(s) [e.g. 6.8.0]
34-
35-
**Additional context**
36-
Add any other context about the problem here.
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+
-->
14+
15+
## System Information
16+
- OS: [e.g. Ubuntu]
17+
- Node.js Version [e.g. Node v20.0.0]
18+
- line-bot-sdk-nodejs version(s) [e.g. 6.8.0]
19+
20+
## Expected Behavior
21+
<!-- Describe what you expected to happen -->
22+
23+
## Current Behavior
24+
<!-- Describe what actually happened instead of the expected behavior -->
25+
26+
## Steps to Reproduce
27+
<!-- Provide a link to a live example or a clear set of steps to reproduce the issue.
28+
If possible, provide minimal code (e.g. test code, a draft PR, or a link to a forked repository). -->
29+
1.
30+
2.
31+
3.
32+
33+
## Logs
34+
<!-- If possible, provide logs to help identify the issue -->
35+
36+
## Additional Context (Optional)
37+
<!-- Add any other context or information that might be relevant to the issue.
38+
For example, related issues, potential causes, or possible solutions. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "Feature Request"
5+
6+
---
7+
8+
## Feature Request
9+
<!-- First of all: Have you checked the docs https://developers.line.biz/en/docs/messaging-api/overview/, Q&A page https://developers.line.biz/en/faq/, GitHub issues whether someone else has already reported your issue? -->
10+
11+
**Is your feature request related to a problem? Please describe.**
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
**Describe the solution you'd like**
15+
A clear and concise description of what you want to happen.
16+
17+
**Describe alternatives you've considered**
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
**Additional context**
21+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: "Question Template"
3+
about: "Use this template to ask questions about usage or implementation of the line-bot-sdk-nodejs."
4+
title: "Question"
5+
---
6+
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+
- [ ] [LINE Messaging API SDK for nodejs](https://line.github.io/line-bot-sdk-nodejs/)
21+
- [ ] [Examples](https://github.com/line/line-bot-sdk-nodejs/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. -->
30+
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. -->
34+
35+
## Your Environment
36+
<!-- For example:
37+
- OS: [e.g. Ubuntu]
38+
- Node.js Version [e.g. Node v22.0.0]
39+
- line-bot-sdk-nodejs version(s) [e.g. 6.8.0]
40+
-->
41+
42+
## Additional Context (Optional)
43+
<!-- 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/issue-label.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)