Skip to content

Add rule for tiny prs #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
louismorgner wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add rule for tiny prs #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,7 @@ This starter kit follows Acta's development principles:
- [ ] CHANGELOG.md updated
- [ ] Lints and builds pass

### Technical Rules
- See `product/TECHNICAL_RULES.md` for engineering rules (e.g., prefer tiny PRs)

Built with ❤️ by Acta, based on the excellent [T3 Turbo](https://github.com/t3-oss/create-t3-turbo) template.
2 changes: 2 additions & 0 deletions product/TEAMWORKFLOW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ This document outlines how we work internally at Acta in the product teams. This
- Always open a PR to `dev` that you squash + merge for a clean commit history.
- Release PRs from `dev` to `main` should include comprehensive changelog updates.

See also: `product/TECHNICAL_RULES.md` for guidelines on PR size and structure (prefer tiny PRs).

## Release process
- **Regular releases** - We promote `dev` to `main` every few days (typically 2-3 days).
- **Release responsibility** - Any team member can initiate a release by creating a PR from `dev` to `main`.
Expand Down
32 changes: 32 additions & 0 deletions product/TECHNICAL_RULES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Technical Rules

This document captures engineering practices that keep quality high while maximizing iteration speed. It is a living document.

## Prefer tiny PRs

Small, focused pull requests lead to faster reviews, fewer defects, and easier rollbacks.

### Why this matters
- Faster review cycles and higher reviewer throughput
- Lower cognitive load and clearer intent per change
- Reduced merge conflicts and safer deploys
- Easier to bisect and revert when issues arise

### Guidelines
- Aim for PRs that can be reviewed in ≤ 10 minutes
- Scope each PR to a single change or concern
- Do not mix refactors with behavior changes; land preparatory refactors separately
- Split work if it touches many files or requires substantial diff volume
- Keep diffs focused; avoid drive-by changes unrelated to the scope
- Provide crisp context in the description (what/why, screenshots if UI, migration notes)
- Include tests for changed behavior (unit/integration/e2e as appropriate)
- Open Draft PRs early to gather feedback and surface risks
- If a large PR is unavoidable: outline the plan, call out risk areas, and list follow-ups

### Reviewer expectations
- Prioritize small PRs for quick turnaround
- If a PR feels too large, request a split into smaller, self-contained changes

### Related
- See `product/TEAMWORKFLOW.md` for the Definition of Done and release process