Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Summary

<!-- What does this pull request change, in one or two sentences? -->

## Why

<!-- The problem it solves. Link the issue (Fixes #123) or name a package and versions that show it. -->

## Changes

-

## Notes for reviewers

<!-- Anything that needs attention after merge (data refresh, migration, config), or "None". -->

## 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
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down