Skip to content

chore: update issue template#1551

Merged
looplj merged 1 commit into
unstablefrom
dev-tmp
Apr 30, 2026
Merged

chore: update issue template#1551
looplj merged 1 commit into
unstablefrom
dev-tmp

Conversation

@looplj

@looplj looplj commented Apr 30, 2026

Copy link
Copy Markdown
Owner

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@greptile-apps

greptile-apps Bot commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR updates all four GitHub issue templates by adding a required FAQ Check checkbox to each, creates a new questions.yml template for Q&A issues, and makes minor housekeeping improvements (trailing whitespace removal, bilingual option ordering standardization, splitting the feature request background/problem fields).

Confidence Score: 5/5

Safe to merge — purely template/documentation changes with no code logic affected

All changes are GitHub issue template YAML files. No logic, no runtime code, and no security implications. The new questions.yml template is well-formed, all required fields are marked correctly, and the FAQ link is consistent across all templates.

No files require special attention

Important Files Changed

Filename Overview
.github/ISSUE_TEMPLATE/bug_report.yml Added FAQ Check checkbox block and removed trailing whitespace from dropdown options
.github/ISSUE_TEMPLATE/feature_request.yml Added FAQ Check checkbox, split "Background and Problem Statement" into separate fields, added optional "Additional Context" textarea
.github/ISSUE_TEMPLATE/optimization.yml Added FAQ Check checkbox and standardized dropdown option order to English-first format
.github/ISSUE_TEMPLATE/questions.yml New question/discussion issue template with checklist, question, context, and category fields

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User opens new issue] --> B{Choose template}
    B --> C[Bug Report]
    B --> D[Feature Request]
    B --> E[Optimization]
    B --> F[Question ✨ new]

    C --> G[Pre-submission Checklist\n✓ searched issues\n✓ read docs]
    D --> G
    E --> G
    F --> G

    G --> H[FAQ Check ✨ added\n✓ checked FAQ #1374]
    H --> I[Fill in template fields]
    I --> J[Submit issue]
Loading

Reviews (1): Last reviewed commit: "chore: update issue template" | Re-trigger Greptile

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request standardizes the GitHub issue templates by adding a mandatory FAQ check to bug reports, feature requests, and optimization suggestions. It also introduces a new template for general questions and discussions. Feedback was provided to modify the FAQ checkbox label in the new questions template to align with the phrasing used in other templates, ensuring consistency across all issue types.

Comment on lines +23 to +24
- label: I have checked the [FAQ](https://github.com/looplj/axonhub/issues/1374) / 我已查阅 FAQ
required: true

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To maintain consistency with the other issue templates (Bug Report, Feature Request, and Optimization), the FAQ checkbox label should explicitly state that the user has confirmed their question is not covered in the FAQ. This encourages a more thorough check before submission and ensures a unified user experience across all issue types.

        - label: I have checked the [FAQ](https://github.com/looplj/axonhub/issues/1374) and this question has not been answered there / 我已查阅 FAQ,此问题尚未被解答
          required: true

@looplj looplj merged commit e808a7a into unstable Apr 30, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant