chore(github): add issue forms and pr template (#566)

This commit is contained in:
Felix
2026-03-18 11:31:11 +08:00
committed by GitHub
Unverified
parent 5a657130c9
commit 554f894493
5 changed files with 192 additions and 0 deletions

76
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,76 @@
name: Bug Report
description: Report a reproducible problem in ClawX.
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for filing a bug report. Please provide enough detail to reproduce and verify a fix.
- type: textarea
id: summary
attributes:
label: Summary
description: Briefly describe the problem.
placeholder: What happened?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: List exact steps to reproduce the issue.
placeholder: |
1. Go to ...
2. Click ...
3. See error ...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
placeholder: What did you expect to happen?
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
placeholder: What actually happened?
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Share OS, app version/commit, and relevant runtime details.
placeholder: |
- OS:
- ClawX version/commit:
- Node/pnpm (if relevant):
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs or Screenshots
description: Paste relevant logs, stack traces, or screenshots.
render: shell
- type: checkboxes
id: checks
attributes:
label: Pre-Submission Checklist
options:
- label: I searched existing issues and did not find a duplicate.
required: true
- label: I can reproduce this issue on the latest main branch build.
required: false

2
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,2 @@
blank_issues_enabled: false
contact_links: []

View File

@@ -0,0 +1,38 @@
name: Documentation
description: Report missing, unclear, or outdated documentation.
title: "[Docs]: "
labels:
- documentation
body:
- type: textarea
id: issue
attributes:
label: Documentation Issue
description: What is missing, unclear, or incorrect?
placeholder: The README section ... is outdated because ...
validations:
required: true
- type: textarea
id: location
attributes:
label: Affected Location
description: Which docs are impacted?
placeholder: README.md / README.zh-CN.md / README.ja-JP.md / other
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Suggested Update
description: What should the docs say instead?
placeholder: Replace ... with ...
validations:
required: true
- type: textarea
id: references
attributes:
label: References
description: Related issue/PR/commit links.

View File

@@ -0,0 +1,51 @@
name: Feature Request
description: Propose a new capability or improvement.
title: "[Feature]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thanks for the suggestion. Clear problem and success criteria help reviewers evaluate quickly.
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What user problem are you trying to solve?
placeholder: The current behavior is ... and it causes ...
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed Solution
description: Describe your preferred solution.
placeholder: We could add ...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Optional alternatives or tradeoffs.
- type: textarea
id: success
attributes:
label: Success Criteria
description: How should we know this is done?
placeholder: |
- [ ] ...
- [ ] ...
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: Mockups, references, related links, etc.

25
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,25 @@
## Summary
<!-- What does this PR change and why? -->
## Related Issue(s)
<!-- e.g. Closes #123 -->
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation
- [ ] Refactor
- [ ] Other
## Validation
<!-- How did you verify this change? -->
## Checklist
- [ ] I ran relevant checks/tests locally.
- [ ] I updated docs if behavior or interfaces changed.
- [ ] I verified there are no unrelated changes in this PR.