Skip to content

Commit f7019b5

Browse files
fleizeanclaude
andcommitted
docs: add a pull request template and tighten the comment rule
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent f3f90be commit f7019b5

2 files changed

Lines changed: 32 additions & 4 deletions

File tree

‎.github/pull_request_template.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Summary
2+
3+
<!-- What does this pull request change, in one or two sentences? -->
4+
5+
## Why
6+
7+
<!-- The problem it solves. Link the issue (Fixes #123) or name a package and versions that show it. -->
8+
9+
## Changes
10+
11+
-
12+
13+
## Notes for reviewers
14+
15+
<!-- Anything that needs attention after merge (data refresh, migration, config), or "None". -->
16+
17+
## Checklist
18+
19+
- [ ] The pull request targets `develop` and is about one thing
20+
- [ ] Commit messages follow Conventional Commits (`feat(scope): ...`, `fix(scope): ...`)
21+
- [ ] CI is green (backend tests, frontend build and tests, dependency gate)
22+
- [ ] Schema changes are EF Core migrations generated by the tool, not hand-edited
23+
- [ ] A changed backend DTO has its TypeScript twin updated in `src/frontend/src/app/core/models`
24+
- [ ] New dependencies are justified and their lock files are updated in the same commit
25+
- [ ] No secrets, tokens or personal data in code, logs or this description
26+
- [ ] Code comments are kept to a minimum; the reasoning lives in this description

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ a PostgreSQL and Redis you can reach on `localhost`.
1717
## Branches and pull requests
1818

1919
- Branch from `develop` and open the pull request into `develop`. `master` only receives releases.
20-
- Keep a pull request about one thing. CI (backend tests, frontend build and tests, dependency gate)
21-
must be green.
20+
- Keep a pull request about one thing and fill in the pull request template, in English. CI
21+
(backend tests, frontend build and tests, dependency gate) must be green.
2222
- Commit messages follow Conventional Commits: `feat(scope): ...`, `fix(scope): ...`, `docs: ...`.
2323

2424
## Code conventions
@@ -36,8 +36,10 @@ with the tool, never edited by hand.
3636
flow (`@if`, `@for` with a stable `track`). All HTTP goes through `ApiService`; a component never
3737
injects `HttpClient`. No `any`. Every HTTP subscription handles its error and resets its loading flag.
3838

39-
**Both:** comments in English, explaining why rather than what. When a backend DTO changes, its
40-
TypeScript twin in `src/frontend/src/app/core/models` changes in the same pull request.
39+
**Both:** few comments, in English. Name things so the code explains itself; comment only a *why* the
40+
code cannot show, never the task or the package that prompted the change (that belongs in the pull
41+
request description). When a backend DTO changes, its TypeScript twin in
42+
`src/frontend/src/app/core/models` changes in the same pull request.
4143

4244
## Dependencies
4345

0 commit comments

Comments
 (0)