Skip to content

Commit 5a321d9

Browse files
chore(github): add PR and issue templates
1 parent b923324 commit 5a321d9

4 files changed

Lines changed: 186 additions & 0 deletions

File tree

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Bug report
2+
description: Report a bug, regression, or broken workflow.
3+
title: "bug: "
4+
labels:
5+
- bug
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Summary
11+
description: What is broken?
12+
placeholder: A short description of the bug.
13+
validations:
14+
required: true
15+
16+
- type: dropdown
17+
id: report_mode
18+
attributes:
19+
label: Report source
20+
description: How was this bug discovered?
21+
options:
22+
- Human user
23+
- Coding agent / automation
24+
- Human + coding agent
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: steps
30+
attributes:
31+
label: Steps to reproduce
32+
description: Provide the smallest reliable reproduction.
33+
placeholder: |
34+
1. Run ...
35+
2. Click ...
36+
3. Observe ...
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: expected
42+
attributes:
43+
label: Expected behavior
44+
placeholder: What should have happened instead?
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: actual
50+
attributes:
51+
label: Actual behavior
52+
placeholder: What happened?
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: environment
58+
attributes:
59+
label: Environment
60+
description: Include CLI version, OS, Python version, model/provider, or any relevant context.
61+
placeholder: weco version, OS, shell, provider, model, etc.
62+
63+
- type: textarea
64+
id: logs
65+
attributes:
66+
label: Logs, screenshots, or extra context
67+
description: Paste logs or add any extra details that will help triage.
68+
69+
- type: checkboxes
70+
id: checks
71+
attributes:
72+
label: Pre-flight
73+
options:
74+
- label: I searched for an existing issue first.
75+
required: true
76+
- label: I can still reproduce this issue.
77+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Feature request
2+
description: Propose a feature, UX improvement, or workflow enhancement.
3+
title: "feat: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
id: summary
9+
attributes:
10+
label: Summary
11+
description: What would you like to see added or improved?
12+
placeholder: A short description of the requested feature.
13+
validations:
14+
required: true
15+
16+
- type: dropdown
17+
id: requester_mode
18+
attributes:
19+
label: Request source
20+
description: Who is proposing this request?
21+
options:
22+
- Human user
23+
- Coding agent / automation
24+
- Human + coding agent
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: problem
30+
attributes:
31+
label: Problem to solve
32+
description: What workflow, pain point, or limitation is driving this request?
33+
placeholder: Describe the underlying problem.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: proposal
39+
attributes:
40+
label: Proposed solution
41+
description: Describe the preferred approach.
42+
placeholder: Explain what should change.
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: alternatives
48+
attributes:
49+
label: Alternatives considered
50+
description: Any workarounds, rejected options, or tradeoffs.
51+
52+
- type: textarea
53+
id: success
54+
attributes:
55+
label: Success criteria
56+
description: How would we know this request is done and successful?
57+
placeholder: Clear acceptance criteria, user outcome, or measurable result.
58+
59+
- type: checkboxes
60+
id: checks
61+
attributes:
62+
label: Pre-flight
63+
options:
64+
- label: I searched for an existing issue first.
65+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Summary
2+
3+
<!-- What changed and why? -->
4+
5+
## Linked Issues
6+
7+
<!-- Example: Closes #123 -->
8+
9+
## Change Type
10+
11+
- [ ] `feat`
12+
- [ ] `fix`
13+
- [ ] `docs`
14+
- [ ] `refactor`
15+
- [ ] `test`
16+
- [ ] `chore`
17+
- [ ] `ci`
18+
19+
## Authorship
20+
21+
<!-- Check the one that best describes how this PR was produced. -->
22+
23+
- [ ] Fully AI-generated
24+
- [ ] Human-directed, AI-authored
25+
- [ ] Human-authored with AI assistance
26+
- [ ] Fully human-authored
27+
28+
## Validation
29+
30+
- [ ] Tests added or updated
31+
- [ ] Existing tests pass
32+
- [ ] Manual verification completed
33+
- [ ] Not applicable
34+
35+
## Notes for Reviewers
36+
37+
<!-- Any context, caveats, rollout notes, or follow-up work -->
38+
39+
## Checklist
40+
41+
- [ ] I checked for accidental secrets or credentials
42+
- [ ] I updated docs, examples, or help text if needed
43+
- [ ] I kept the change scoped and reviewable

0 commit comments

Comments
 (0)