feat: add PR and issue templates for contributor workflow (#296)
Adds structured templates to help contributors submit higher-quality PRs and issues. PR template includes testing checklist (pytest, sync.sh). Issue templates use YAML forms for bug reports and feature requests. Fixes #251
This commit is contained in:
@@ -0,0 +1,53 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: Report a bug or unexpected behavior
|
||||||
|
labels: [bug]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: summary
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: What happened?
|
||||||
|
placeholder: Describe the bug in 1-2 sentences.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: repro
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: How can we reproduce this?
|
||||||
|
placeholder: |
|
||||||
|
1. Run `python3 scripts/last30days.py "topic" --emit compact`
|
||||||
|
2. ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: What should have happened?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: traceback
|
||||||
|
attributes:
|
||||||
|
label: Error / Traceback
|
||||||
|
description: Paste the full traceback or error output.
|
||||||
|
render: text
|
||||||
|
- type: dropdown
|
||||||
|
id: install
|
||||||
|
attributes:
|
||||||
|
label: Install Method
|
||||||
|
options:
|
||||||
|
- Claude Code plugin
|
||||||
|
- Gemini CLI extension
|
||||||
|
- Codex plugin
|
||||||
|
- Hermes skill
|
||||||
|
- Manual (git clone)
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: OS
|
||||||
|
placeholder: macOS 15.4, Ubuntu 24.04, Windows 11, etc.
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
name: Feature Request
|
||||||
|
description: Suggest a new feature or improvement
|
||||||
|
labels: [enhancement]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: problem
|
||||||
|
attributes:
|
||||||
|
label: Problem
|
||||||
|
description: What problem does this solve?
|
||||||
|
placeholder: When I try to ..., I can't ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: Proposed Solution
|
||||||
|
description: How should this work?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: alternatives
|
||||||
|
attributes:
|
||||||
|
label: Alternatives Considered
|
||||||
|
description: Other approaches you thought of (optional).
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
## Summary
|
||||||
|
|
||||||
|
<!-- What does this PR do? 1-3 sentences. -->
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
<!-- Bullet list of what changed. Reference files if helpful. -->
|
||||||
|
|
||||||
|
-
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
<!-- How did you verify this works? -->
|
||||||
|
|
||||||
|
- [ ] Ran `uv run python -m pytest -q --tb=short`
|
||||||
|
- [ ] Ran `bash scripts/sync.sh` (if scripts/ changed)
|
||||||
|
|
||||||
|
## Related Issues
|
||||||
|
|
||||||
|
<!-- Link issues: Fixes #123 or Relates to #456 -->
|
||||||
Reference in New Issue
Block a user