Skip to content

Commit d99a47a

Browse files
authored
chore: add issue and pull request templates (#313)
* chore: add GitHub issue templates Add bug report, feature request, and question templates to standardize issue reporting. Signed-off-by: cxhello <caixiaohuichn@gmail.com> * chore: add pull request template Signed-off-by: cxhello <caixiaohuichn@gmail.com> * chore: address PR review feedback on issue and PR templates - 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> --------- Signed-off-by: cxhello <caixiaohuichn@gmail.com>
1 parent 26e1f57 commit d99a47a

5 files changed

Lines changed: 132 additions & 0 deletions

File tree

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
### Environment
10+
11+
- **SDK Package Version**: (e.g., 3.2.0b1)
12+
- **Python Version**: (e.g., 3.10 / 3.12 / 3.13)
13+
- **Nacos Server Version**: (e.g., 3.0.3)
14+
- **OS**: (e.g., Ubuntu 22.04 / macOS 15 / Windows 11)
15+
16+
### Describe the Bug
17+
18+
A clear and concise description of what the bug is.
19+
20+
### Steps to Reproduce
21+
22+
1.
23+
2.
24+
3.
25+
26+
### Minimal Reproducible Code
27+
28+
```python
29+
# Paste your code here
30+
```
31+
32+
### Expected Behavior
33+
34+
A clear and concise description of what you expected to happen.
35+
36+
### Actual Behavior
37+
38+
A clear and concise description of what actually happened.
39+
40+
### Error Logs / Stack Trace
41+
42+
```
43+
Paste any relevant logs or stack traces here
44+
```
45+
46+
### Additional Context
47+
48+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Documentation
4+
url: https://nacos.io/docs/latest/what-is-nacos/
5+
about: Please check the Nacos documentation before asking a question.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
### Description
10+
11+
A clear and concise description of the feature you'd like.
12+
13+
### Use Case
14+
15+
Describe the problem or use case that this feature would address.
16+
17+
### Proposed Solution
18+
19+
A clear and concise description of what you want to happen.
20+
21+
### Alternatives Considered
22+
23+
A clear and concise description of any alternative solutions or features you've considered.
24+
25+
### Additional Context
26+
27+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Question
3+
about: Ask a question about usage or configuration
4+
title: "[Question] "
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
### Description
10+
11+
A clear and concise description of your question.
12+
13+
### What Have You Tried
14+
15+
Describe what you've already tried or researched.
16+
17+
### Relevant Code or Configuration
18+
19+
```python
20+
# Paste your code here if applicable
21+
```
22+
23+
### Additional Context
24+
25+
Add any other context about the question here.

.github/pull_request_template.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
### What type of PR is this?
2+
3+
- [ ] Bug fix
4+
- [ ] New feature
5+
- [ ] Enhancement
6+
- [ ] Refactoring
7+
- [ ] Documentation
8+
- [ ] CI/CD
9+
- [ ] Other
10+
11+
### What does this PR do?
12+
13+
<!-- A brief description of the changes. -->
14+
15+
### Which issue(s) does this PR fix?
16+
17+
<!-- Link to the related issue(s). e.g., Fixes #123 -->
18+
19+
### How has this been tested?
20+
21+
<!-- Describe the testing you have done. -->
22+
23+
### Checklist
24+
25+
- [ ] Unit tests added/updated
26+
- [ ] Documentation updated (if needed)
27+
- [ ] No breaking changes (or described above)

0 commit comments

Comments
 (0)