From f7019b50ee0b9643e06340d0c6bc8dc9e8f021e9 Mon Sep 17 00:00:00 2001 From: fleizean <66090171+fleizean@users.noreply.github.com> Date: Mon, 19 Oct 2026 19:35:57 +0300 Subject: [PATCH] docs: add a pull request template and tighten the comment rule Co-Authored-By: Claude Opus 5.5 (1M context) --- .github/pull_request_template.md | 26 ++++++++++++++++++++++++++ CONTRIBUTING.md | 10 ++++++---- 2 files changed, 32 insertions(+), 4 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1975fc2 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +## Summary + + + +## Why + + + +## Changes + +- + +## Notes for reviewers + + + +## Checklist + +- [ ] The pull request targets `develop` and is about one thing +- [ ] Commit messages follow Conventional Commits (`feat(scope): ...`, `fix(scope): ...`) +- [ ] CI is green (backend tests, frontend build and tests, dependency gate) +- [ ] Schema changes are EF Core migrations generated by the tool, not hand-edited +- [ ] A changed backend DTO has its TypeScript twin updated in `src/frontend/src/app/core/models` +- [ ] New dependencies are justified and their lock files are updated in the same commit +- [ ] No secrets, tokens or personal data in code, logs or this description +- [ ] Code comments are kept to a minimum; the reasoning lives in this description diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d81fcfb..74a6ad8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,8 +17,8 @@ a PostgreSQL and Redis you can reach on `localhost`. ## Branches and pull requests - Branch from `develop` and open the pull request into `develop`. `master` only receives releases. -- Keep a pull request about one thing. CI (backend tests, frontend build and tests, dependency gate) - must be green. +- Keep a pull request about one thing and fill in the pull request template, in English. CI + (backend tests, frontend build and tests, dependency gate) must be green. - Commit messages follow Conventional Commits: `feat(scope): ...`, `fix(scope): ...`, `docs: ...`. ## Code conventions @@ -36,8 +36,10 @@ with the tool, never edited by hand. flow (`@if`, `@for` with a stable `track`). All HTTP goes through `ApiService`; a component never injects `HttpClient`. No `any`. Every HTTP subscription handles its error and resets its loading flag. -**Both:** comments in English, explaining why rather than what. When a backend DTO changes, its -TypeScript twin in `src/frontend/src/app/core/models` changes in the same pull request. +**Both:** few comments, in English. Name things so the code explains itself; comment only a *why* the +code cannot show, never the task or the package that prompted the change (that belongs in the pull +request description). When a backend DTO changes, its TypeScript twin in +`src/frontend/src/app/core/models` changes in the same pull request. ## Dependencies