From f31a322978ca265eebfc61fda41feed3b82865e2 Mon Sep 17 00:00:00 2001 From: Jiayuan Zhang Date: Sun, 12 Apr 2026 13:58:18 +0800 Subject: [PATCH] chore: add issue templates and improve PR template (#759) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: add issue templates and improve PR template Add GitHub issue templates (bug report, feature request) using YAML forms, referencing hermes-agent's template structure. Update the PR template with clearer sections for changes made, related issues, and a more comprehensive checklist. * chore: add AI disclosure section to PR template Since most PRs are now authored or co-authored by AI coding tools, add a dedicated AI Disclosure section to the PR template. Includes authorship type, tool used, and a human review checklist to ensure AI-generated code is properly reviewed before merge. * chore: simplify AI disclosure to focus on prompt sharing Remove the review-status checklist — it was too heavy and users won't actually do it. Instead focus on what's useful: which AI tool was used and what prompt/approach produced the code, so the team can learn from each other's AI workflows. * chore: simplify issue templates to lower submission friction Bug report: just what happened + steps to reproduce (required), plus an optional context field for logs/env. Feature request: just what you want and why (required), plus an optional proposed solution. Removed all dropdowns, environment fields, checkboxes, and other fields that discourage users from filing issues. * chore: add screenshots section to issue templates Add optional screenshots field to both bug report and feature request templates so users can attach images for richer context. --- .github/ISSUE_TEMPLATE/bug_report.yml | 39 ++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 26 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 52 +++++++++++++++------- 4 files changed, 103 insertions(+), 15 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..7c8ac2729 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,39 @@ +name: "Bug Report" +description: Report a bug — something that's broken, crashes, or behaves incorrectly. +title: "[Bug]: " +labels: ["bug"] +body: + - type: textarea + id: description + attributes: + label: What happened? + description: Describe the bug and what you expected instead. Screenshots, error messages, or screen recordings are welcome. + placeholder: | + When I do X, Y happens. I expected Z instead. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: How can we trigger this bug? + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. See error + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots (optional) + description: If applicable, add screenshots or screen recordings to help explain the problem. + + - type: textarea + id: context + attributes: + label: Additional context (optional) + description: Environment info, logs, or anything else that might help. + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..0086358db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..8d95bea4d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,26 @@ +name: "Feature Request" +description: Suggest a new feature or improvement. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: textarea + id: description + attributes: + label: What do you want and why? + description: Describe the problem you're trying to solve or the improvement you'd like to see. + placeholder: | + I'm trying to do X but there's no way to... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed solution (optional) + description: If you have an idea for how this should work, describe it here. + + - type: textarea + id: screenshots + attributes: + label: Screenshots / mockups (optional) + description: If applicable, add screenshots, mockups, or sketches to illustrate your idea. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d89681790..ad8488dc9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,34 +1,56 @@ -## What +## What does this PR do? - + -## Why - -Closes # +## Related Issue + + + +Closes # ## Type of Change -- [ ] Bug fix -- [ ] New feature -- [ ] Refactor / code improvement -- [ ] Documentation +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Refactor / code improvement (no behavior change) +- [ ] Documentation update +- [ ] Tests (adding or improving test coverage) - [ ] CI / infrastructure -- [ ] Other (describe below) + +## Changes Made + + + +- ## How to Test - + + +1. +2. +3. ## Checklist +- [ ] I searched for [existing PRs](https://github.com/multica-ai/multica/pulls) to make sure this isn't a duplicate +- [ ] My commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) (`fix(scope):`, `feat(scope):`, etc.) - [ ] `make check` passes (typecheck, unit tests, Go tests, E2E) - [ ] Changes follow existing code patterns and conventions - [ ] No unrelated changes included -## AI Disclosure (optional) +## AI Disclosure - - - + + +**AI tool used:** + +**Prompt / approach:** + + + +## Screenshots (optional) + +