Skip to content

Commit 6978d0b

Browse files
authored
Merge pull request #1918 from wheels-dev/peter/pr-template
2 parents 4dc18eb + c824dca commit 6978d0b

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

.github/pull_request_template.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Summary
2+
3+
<!-- Brief description of what this PR does -->
4+
5+
## Related Issue
6+
7+
Closes #
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Enhancement to existing feature
14+
- [ ] Documentation update
15+
- [ ] Refactoring
16+
17+
## Feature Completeness Checklist
18+
19+
<!-- All items must be checked for new features and enhancements -->
20+
21+
- [ ] **Tests** -- Unit tests covering happy path, edge cases, and error conditions
22+
- [ ] **Framework Docs** -- New or updated page in `docs/src/` with `SUMMARY.md` entry
23+
- [ ] **AI Reference Docs** -- New or updated file in `.ai/wheels/` directory
24+
- [ ] **CLAUDE.md** -- Updated if the feature changes model/controller/view conventions
25+
- [ ] **CHANGELOG.md** -- Entry under `[Unreleased]` section
26+
- [ ] **Test runner passes** -- All existing tests still pass (`/wheels/tests/core?format=json`)
27+
28+
## Test Plan
29+
30+
<!-- How to verify this PR works -->
31+
32+
## Screenshots / Output
33+
34+
<!-- If applicable -->

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,19 @@ We welcome PRs of all sizes — from typo fixes to major features. To make revie
102102
* Use meaningful variable and function names
103103
* Add comments for complex logic
104104

105+
**Definition of Done:**
106+
107+
A feature or enhancement is not complete until all of the following are satisfied:
108+
109+
* **Tests** -- Unit tests covering happy path, edge cases, and error conditions in `vendor/wheels/tests/`
110+
* **Framework Docs** -- New or updated page in `docs/src/` with a corresponding entry in `docs/src/SUMMARY.md`
111+
* **AI Reference Docs** -- New or updated file in `.ai/wheels/` so AI assistants have accurate context
112+
* **CLAUDE.md** -- Updated if the feature changes model, controller, or view conventions
113+
* **CHANGELOG.md** -- Entry under the `[Unreleased]` section
114+
* **Test runner passes** -- All existing tests still pass (`/wheels/tests/core?format=json`)
115+
116+
Bug-fix PRs require tests and a CHANGELOG entry at minimum. Documentation-only PRs are exempt from the test requirement.
117+
105118
If you're making a **breaking change** or working on **core functionality**, it's best to open an Issue first to discuss the approach.
106119

107120
**Fork-and-Pull Workflow:**

0 commit comments

Comments
 (0)