Skip to content

Commit 542fa97

Browse files
committed
docs: more on squash commiting
1 parent e1f0a19 commit 542fa97

File tree

1 file changed

+65
-17
lines changed

1 file changed

+65
-17
lines changed

src/content/docs/project/maintain.md

Lines changed: 65 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,84 @@ This guide walks you through reviewing and merging pull requests. We've organize
1010

1111
Before merging any PR (except all-contributors bot PRs), make sure:
1212

13-
-**CI checks are green** - All tests, linting, and link checks pass
14-
-**Branch is current** - Synced with `main` (merge or rebase)
15-
-**Comments resolved** - All review feedback addressed
16-
-**Issues linked** - Related issues referenced in PR description
17-
-**Clear description** - Follows Angular commit convention and explains changes
18-
-**You have the right approvals** - See approval requirements below
13+
***CI checks are green**: All tests, linting, and link checks pass
14+
***Branch is current**: Synced with `main` (merge or rebase)
15+
***Comments resolved**: All review feedback addressed
16+
***Issues linked**: Related issues referenced in PR description
17+
***Clear description**: Follows Angular commit convention and explains changes
18+
***You have the right approvals**: See approval requirements below
1919

2020
## PR Approval Requirements
2121

2222
### No approval required
2323

24-
- **All-contributors bot PRs** - Any maintainer can merge without approval
25-
- **Dependabot PRs** - Any maintainer can merge once CI is green
24+
* **All-contributors bot PRs**: Any maintainer can merge without approval
25+
* **Dependabot PRs**: Any maintainer can merge once CI is green
2626

2727
### One approval required
2828

2929
Most PRs fall here:
30-
- Documentation updates
31-
- Small bug fixes
32-
- Maintenance work
33-
- Non-breaking changes
30+
* Documentation updates
31+
* Small bug fixes
32+
* Maintenance work
33+
* Non-breaking changes
3434

3535
### Two approvals required
3636

37-
For large or sensitive changes:
38-
- API changes
39-
- Major refactors
40-
- Significant security fixes
41-
- Changes affecting many consumers
37+
For large or sensitive changes such as:
38+
* API changes
39+
* Major refactors
40+
* Significant security fixes
41+
* Changes affecting the bot's API and our users
4242

4343
💡 **Tip:** For these larger changes, please open an issue to discuss the design before submitting the PR.
4444

45+
## Merging PRs - Use Squash and Merge
46+
47+
**Always use "Squash and Merge"** to keep our commit history clean and meaningful.
48+
49+
### Format the squash commit message
50+
51+
Follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
52+
```
53+
<type>(<scope>): <description>
54+
55+
[optional body]
56+
57+
[optional footer]
58+
```
59+
60+
**Common types:**
61+
* `feat:`: New feature
62+
* `fix:`: Bug fix
63+
* `docs:`: Documentation changes
64+
* `style:`: Code style changes (formatting, no logic change)
65+
* `refactor:`: Code refactoring
66+
* `test:`: Adding or updating tests
67+
* `chore:`: Maintenance tasks, dependency updates
68+
69+
**Examples:**
70+
71+
```md
72+
feat(api): add support for custom headers
73+
74+
fix(parser): handle empty strings correctly
75+
76+
docs(readme): update installation instructions
77+
78+
chore(deps): bump tailwindcss from 4.17.20 to 4.17.21
79+
```
80+
81+
💡 **Tip:** The scope is optional but helpful. Use it to indicate what part of the project changed (e.g., `api`, `cli`, `docs`, `tests`).
82+
83+
### Why squash merge?
84+
85+
We use the squash-merge approach because it provides:
86+
* **Clean history**: One commit per PR makes the history easy to read
87+
* **Meaningful commits**: Each commit represents a complete feature or fix
88+
* **Easy reverts**: Can revert an entire feature with one command
89+
* **Better changelogs**: Conventional commits enable automated changelog generation
90+
4591
## Merging Your Own PRs
4692

4793
As a maintainer, please avoid merging your own PRs when possible. Having another set of eyes review is good practice!
@@ -63,6 +109,8 @@ Contributors are asked to do this themselves, but they often forget. Please chec
63109

64110
**Note:** If the contributor is already listed for that contribution type (e.g., they're already in the table for `bug`), you don't need to add them again.
65111

112+
113+
66114
## Need Help with Reviews?
67115

68116
- Ping maintainers who've been active on related issues

0 commit comments

Comments
 (0)