Skip to content

Add standardized issue templates#25

Open
thc1006 wants to merge 1 commit into
developfrom
mnt/issue-templates
Open

Add standardized issue templates#25
thc1006 wants to merge 1 commit into
developfrom
mnt/issue-templates

Conversation

@thc1006
Copy link
Copy Markdown
Member

@thc1006 thc1006 commented May 18, 2026

Add GitHub issue form templates under .github/ISSUE_TEMPLATE/, per #19.

What this adds

  • bug_report.yml -- a bug in the simulator, environment, or evaluation. Collects what happened, repro steps, traceback, and environment.
  • feature_request.yml -- an enhancement or design proposal. Collects problem / current state, the proposed change, and alternatives / trade-offs.
  • question.yml -- usage, competition, or leaderboard questions.
  • config.yml -- keeps blank issues enabled as an escape hatch.

All are YAML issue forms (GitHub's current format) and in English. The labels they apply (bug, enhancement, question) are GitHub's default label set.

The set is deliberately minimal and easy to extend later.

Closes #19

Add GitHub issue form templates under .github/ISSUE_TEMPLATE: a bug
report, a feature request / proposal, and a question form, plus a
config that keeps blank issues enabled. Each form collects the
context that otherwise has to be asked for in follow-up comments.

Signed-off-by: thc1006 <84045975+thc1006@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 18, 2026 01:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds standardized GitHub issue form templates under .github/ISSUE_TEMPLATE/ to give contributors structured templates for bug reports, feature proposals, and questions, while preserving the option to file blank issues. Closes #19.

Changes:

  • Adds three YAML issue forms (bug report, feature request, question) with required/optional fields and default labels.
  • Adds a config.yml that explicitly keeps blank issues enabled.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
.github/ISSUE_TEMPLATE/bug_report.yml Bug template collecting summary, repro steps, traceback, and environment.
.github/ISSUE_TEMPLATE/feature_request.yml Proposal template covering problem, proposed change, and alternatives.
.github/ISSUE_TEMPLATE/question.yml Lightweight question template with question and context fields.
.github/ISSUE_TEMPLATE/config.yml Keeps blank issues enabled as an escape hatch.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Member

@zuorenchen zuorenchen left a comment

Choose a reason for hiding this comment

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

LGTM, you can merge it if @William-Mou doesn't have any comment on this.

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.

3 participants