Skip to content

Improve issue triage and issue template #812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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
<!-- Delete this section before the submit -->

- 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
<!-- Delete this section before the submit -->

- 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
<!--
## Before Creating an Issue
- 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
- Make sure the issue you are reporting isn't already addressed in the documentation or existing issues.
## When Creating an Issue
- Provide detailed information about the issue you experienced with the SDK using the template below.
-->

* 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
<!-- Tell us what should happen -->
<!-- Describe what you expected to happen -->

## Current Behavior
<!-- Tell us what happens instead of the expected behavior -->
<!-- Describe what actually happened instead of the expected behavior -->

## Steps to Reproduce
<!-- Provide a link to a live example, or an unambigeous set of steps to -->
1.
1.
1.
<!-- Provide a link to a live example or a clear set of steps to reproduce the issue.
If possible, provide minimal code (e.g. test code, a draft PR, or a link to a forked repository). -->
1.
2.
3.

## Logs
<!-- Provide logs if possible -->
<!-- If possible, provide logs to help identify the issue -->

## Additional Context (Optional)
<!-- Add any other context or information that might be relevant to the issue.
For example, related issues, potential causes, or possible solutions. -->
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
name: "Documentation"
about: Report an issue related to README.md or https://line-bot-sdk-python.readthedocs.io
labels: ''

title: "Documentation Issue"
---

## Documentation
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
48 changes: 38 additions & 10 deletions .github/ISSUE_TEMPLATE/questions.md
Original file line number Diff line number Diff line change
@@ -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
<!-- Delete this section before the submit -->
<!--
## Before Creating a Question Issue
- 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.
- Make sure your question hasn't already been asked in other Issues or the documentation.
## This Is Not
- A bug report. If you think you've found a bug, please use the "Bug Report" template.
- A place to request new features. If you have a feature request, consider opening a "Feature Request" issue or PR.
## When Creating a Question
- Provide detailed information about your environment and context so we can better understand and answer your question.
- Let us know what you've tried so far (e.g. searching docs, existing issues, etc.).
-->

## Have You Checked the Following?
- [ ] [SDK Document](https://line-bot-sdk-python.readthedocs.io/en/latest/)
- [ ] [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/)

## Summary of Your Question
<!-- Provide a clear and concise description of what you want to know. -->

## Details
<!-- Provide any code snippets, relevant logs, or background details that will help us understand your question better. -->

- 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
<!-- Let us know any steps you've already taken to answer your own question,
such as searching in documentation or checking existing issues. -->

## When creating an issue
<!-- Delete this section before the submit -->
## Your Environment
<!-- For example:
- Python version:
- line-bot-sdk-python version:
- OS (and version):
- Any other relevant environment details (e.g. Framework version, hosting service, etc.):
-->

- 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)
<!-- Add any other context, possible considerations, or related links here. -->
2 changes: 1 addition & 1 deletion .github/workflows/close-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
32 changes: 32 additions & 0 deletions .github/workflows/label-issue.yml
Original file line number Diff line number Diff line change
@@ -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 }}