oblachno-oss/grm
3
0
Fork 0
Code Issues 31 Pull Requests Actions Packages Projects Releases 21 Wiki Activity

GRM-33: feat: add mandatory PR review step to workflow

Browse Source
This commit is contained in:
emil
2026-06-21 06:02:50 +00:00
parent 1717d55013
commit 5c1d848311
11 changed files with 726 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -3
View File
@@ -10,10 +10,28 @@ Each runner runs in an isolated **rootless Docker** environment under a dedicate
## Commit Convention & Branch Naming
This project uses **conventional commits** and **GRM-N branch prefixes**. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
This project uses **conventional commits** and **GRM-N branch prefixes**. See [AGENTS.md](AGENTS.md) for the full workflow.
- Branches: `GRM-N` or `GRM-N-brief-description` (required for CI automation)
- Commits: `feat:`, `fix:`, `chore:`, etc. (no `GRM-N:` prefix on feature branches)
| What | Format | Example |
|------|--------|---------|
| Branch name | `GRM-N-short-description` | `GRM-33-add-pr-review-step` |
| Branch commits | `<conventional commit>` | `feat: add review script` |
| PR title | `GRM-N: <vikunja task title>` | `GRM-33: Add mandatory PR review step` |
| Merge commit | `GRM-N <conventional commit>` | `GRM-33 feat: add review script` |
### PR Workflow
Every change to master goes through a mandatory review workflow:
1. **Create Vikunja task** — get a `GRM-N` identifier
2. **Create branch** — `GRM-N-short-description`
3. **Implement** — write code, tests (100% coverage), update docs
4. **Commit** — conventional commits (no `GRM-N:` prefix on branch)
5. **Push & create PR** — title: `GRM-N: <vikunja task title>`
6. **Review** — review the full diff focusing on: functional completeness, edge cases, technical excellence (architecture, SRP, deduplication, code smells, best practices, code quality, reusability, clean code, readability, maintainability, extensibility), performance, security, UX, documentation completeness/relevance. Post review comments via `scripts/review_pr.py`.
7. **Address comments** — fix each comment, commit, push, re-review
8. **Approve** — post an `APPROVE` review via `scripts/review_pr.py`
9. **Add `ready-to-merge` label** — auto-merge workflow squash-merges with title `GRM-N <conventional commit message>`, post-merge workflow marks the Vikunja task as done
## Features