Skip to content

chore: add issue and pull request templates#313

Merged
Sunrisea merged 3 commits intonacos-group:masterfrom
cxhello:chore/add-issue-templates
Apr 27, 2026
Merged

chore: add issue and pull request templates#313
Sunrisea merged 3 commits intonacos-group:masterfrom
cxhello:chore/add-issue-templates

Conversation

@cxhello
Copy link
Copy Markdown
Contributor

@cxhello cxhello commented Mar 13, 2026

What type of PR is this?

  • CI/CD

What does this PR do?

  • Add issue templates for bug reports, feature requests, and questions
  • Add pull request template to standardize PR descriptions
  • Add template config with link to Nacos documentation
Template Purpose
ISSUE_TEMPLATE/bug_report.md Collect environment info, reproduction steps, and error logs
ISSUE_TEMPLATE/feature_request.md Describe use case and proposed solution (V2/V3)
ISSUE_TEMPLATE/question.md Usage questions with context
ISSUE_TEMPLATE/config.yml Allow blank issues + link to Nacos docs
pull_request_template.md Standardize PR type, description, related issues, and testing

Which issue(s) does this PR fix?

N/A

How has this been tested?

Verified templates render correctly on GitHub.

cxhello added 2 commits March 13, 2026 13:15
Add bug report, feature request, and question templates
to standardize issue reporting.

Signed-off-by: cxhello <caixiaohuichn@gmail.com>
Signed-off-by: cxhello <caixiaohuichn@gmail.com>
@cxhello cxhello changed the title chore: add GitHub issue templates chore: add issue and pull request templates Mar 13, 2026
@Sunrisea
Copy link
Copy Markdown
Member

Thanks for adding the templates! Overall LGTM, a few tweaks before merge:

1. Drop the V2 / V3 field. This repo only ships v2/ — no v3/ package or imports exist. Offering that choice will mislead reporters. Applies to bug_report.md, feature_request.md, question.md.

2. Refresh stale examples in bug_report.md. SDK Package Version: 2.0.53.2.0b1; Nacos Server Version: 2.4.03.0.3.

3. Add a Checklist to pull_request_template.md:

### Checklist
- [ ] Unit tests added/updated
- [ ] Documentation updated (if needed)
- [ ] No breaking changes (or described above)

4. Consider migrating to YAML Issue Forms (follow-up). The current .md + front-matter format is legacy. YAML forms (.yml) support required fields, dropdowns (Python / Nacos Server versions), and prerequisite checkboxes — much better UX. Can be a separate PR.

- Remove V2/V3 SDK version field from all issue templates
- Update version examples to 3.2.0b1 (SDK) and 3.0.3 (Server)
- Add checklist section to pull request template

Signed-off-by: cxhello <caixiaohuichn@gmail.com>
@cxhello
Copy link
Copy Markdown
Contributor Author

cxhello commented Apr 27, 2026

@Sunrisea 改完了 再看看是否可以

@Sunrisea
Copy link
Copy Markdown
Member

LGTM

@Sunrisea Sunrisea merged commit d99a47a into nacos-group:master Apr 27, 2026
6 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.

2 participants