chore: add PR template and bug report issue template (#574)
* chore: add PR template and bug report issue template Standardize PR descriptions and bug reports with structured templates to improve consistency across contributors. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * chore: simplify PR template — replace milestone/slice with target branch Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * chore: rename section to 'Release context' Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
71cf0eef3b
commit
7bad35702e
2 changed files with 156 additions and 0 deletions
107
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
107
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
name: Bug Report
|
||||
description: Report a bug in GSD
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting a bug! Please fill out the sections below so we can reproduce and fix it.
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: GSD version
|
||||
description: Run `gsd --version` or check `package.json`
|
||||
placeholder: "e.g., 2.15.0"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Affected area
|
||||
options:
|
||||
- Auto-mode / dispatch loop
|
||||
- TUI / terminal display
|
||||
- Planning / roadmap
|
||||
- Phase execution
|
||||
- Git / worktree isolation
|
||||
- Hook orchestration
|
||||
- State management
|
||||
- AI provider integration
|
||||
- CLI / commands
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: A clear description of the bug.
|
||||
placeholder: "When I run X, Y happens instead of Z."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: What should have happened instead?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Minimal steps to trigger the bug.
|
||||
placeholder: |
|
||||
1. Run `gsd ...`
|
||||
2. Select option ...
|
||||
3. See error
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Error output / logs
|
||||
description: Paste any error messages or relevant log output.
|
||||
render: shell
|
||||
|
||||
- type: dropdown
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating system
|
||||
options:
|
||||
- macOS
|
||||
- Linux
|
||||
- Windows
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: node-version
|
||||
attributes:
|
||||
label: Node.js version
|
||||
description: Run `node --version`
|
||||
placeholder: "e.g., v22.4.0"
|
||||
|
||||
- type: dropdown
|
||||
id: ai-provider
|
||||
attributes:
|
||||
label: AI provider (if relevant)
|
||||
options:
|
||||
- Anthropic (Claude)
|
||||
- OpenRouter
|
||||
- OpenAI-compatible
|
||||
- Other
|
||||
- N/A
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Anything else — screenshots, config snippets, related issues.
|
||||
49
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
49
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
## Summary
|
||||
<!-- What does this PR do? 1-3 bullet points. -->
|
||||
|
||||
-
|
||||
|
||||
## Motivation
|
||||
<!-- Why is this change needed? Link issues if applicable. -->
|
||||
|
||||
Closes #
|
||||
|
||||
## Change type
|
||||
<!-- Check one: -->
|
||||
- [ ] `feat` — New feature or capability
|
||||
- [ ] `fix` — Bug fix
|
||||
- [ ] `refactor` — Code restructuring (no behavior change)
|
||||
- [ ] `test` — Adding or updating tests
|
||||
- [ ] `docs` — Documentation only
|
||||
- [ ] `chore` — Build, CI, or tooling changes
|
||||
|
||||
## Scope
|
||||
<!-- Which packages/areas does this touch? Check all that apply. -->
|
||||
- [ ] `pi-tui` — Terminal UI
|
||||
- [ ] `pi-ai` — AI/LLM layer
|
||||
- [ ] `pi-agent-core` — Agent orchestration
|
||||
- [ ] `pi-coding-agent` — Coding agent
|
||||
- [ ] `gsd extension` — GSD workflow (`src/resources/extensions/gsd/`)
|
||||
- [ ] `native` — Native bindings
|
||||
- [ ] `ci/build` — Workflows, scripts, config
|
||||
|
||||
## Breaking changes
|
||||
<!-- Does this change any public API, CLI behavior, config format, or file structure? -->
|
||||
- [ ] No breaking changes
|
||||
- [ ] Yes — describe below:
|
||||
|
||||
## Test plan
|
||||
<!-- How was this tested? Check all that apply. -->
|
||||
- [ ] Unit tests added/updated (`npm run test:unit`)
|
||||
- [ ] Integration tests added/updated (`npm run test:integration`)
|
||||
- [ ] Manual testing — describe steps:
|
||||
- [ ] No tests needed — explain why:
|
||||
|
||||
## Rollback plan
|
||||
<!-- If this causes issues in production, how do we revert safely? -->
|
||||
- [ ] Safe to revert (no migrations, no state changes)
|
||||
- [ ] Requires steps — describe:
|
||||
|
||||
## Release context
|
||||
<!-- What branch does this PR target? -->
|
||||
- **Target**: <!-- e.g., milestone/2.15.x or main -->
|
||||
Loading…
Add table
Reference in a new issue