You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/project/maintain.md
+17-12Lines changed: 17 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
id: maintain
3
-
title: Maintaining the project
3
+
title: Maintaining the project
4
4
sidebar_label: Help us Improve
5
5
---
6
6
@@ -27,6 +27,7 @@ Before merging any PR (except all-contributors bot PRs), make sure:
27
27
### One approval required
28
28
29
29
Most PRs fall here:
30
+
30
31
* Documentation updates
31
32
* Small bug fixes
32
33
* Maintenance work
@@ -35,6 +36,7 @@ Most PRs fall here:
35
36
### Two approvals required
36
37
37
38
For large or sensitive changes such as:
39
+
38
40
* API changes
39
41
* Major refactors
40
42
* Significant security fixes
@@ -49,7 +51,8 @@ For large or sensitive changes such as:
49
51
### Format the squash commit message
50
52
51
53
Follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
52
-
```
54
+
55
+
```none
53
56
<type>(<scope>): <description>
54
57
55
58
[optional body]
@@ -58,6 +61,7 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
58
61
```
59
62
60
63
**Common types:**
64
+
61
65
*`feat:`: New feature
62
66
*`fix:`: Bug fix
63
67
*`docs:`: Documentation changes
@@ -83,6 +87,7 @@ chore(deps): bump tailwindcss from 4.17.20 to 4.17.21
83
87
### Why squash merge?
84
88
85
89
We use the squash-merge approach because it provides:
90
+
86
91
***Clean history**: One commit per PR makes the history easy to read
87
92
***Meaningful commits**: Each commit represents a complete feature or fix
88
93
***Easy reverts**: Can revert an entire feature with one command
@@ -93,29 +98,29 @@ We use the squash-merge approach because it provides:
93
98
As a maintainer, please avoid merging your own PRs when possible. Having another set of eyes review is good practice!
94
99
95
100
**If you must self-merge** (urgent/security/critical fix):
96
-
- Request a quick review if someone is available, OR
97
-
- Leave a note in the PR explaining why you're self-merging
101
+
102
+
* Request a quick review if someone is available, OR
103
+
* Leave a note in the PR explaining why you're self-merging
98
104
99
105
## After Merging
100
106
101
107
### Add contributors to the all-contributors table
102
108
103
109
When you merge a PR, add the contributor using this command:
104
-
```
110
+
111
+
```none
105
112
@all-contributors please add <github-username> for <contribution-roles>
106
113
```
107
114
108
115
Contributors are asked to do this themselves, but they often forget. Please check and add them if needed!
109
116
110
117
**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.
111
118
112
-
113
-
114
119
## Need Help with Reviews?
115
120
116
-
- Ping maintainers who've been active on related issues
117
-
- As a last resort, carefully ping the `@maintainers` team
118
-
119
-
---
121
+
* Ping maintainers who've been active on related issues
122
+
* As a last resort, carefully ping the `@maintainers` team
120
123
121
-
*Remember: This process helps us maintain code quality while keeping things moving. When in doubt, ask for a second opinion! And also, be sure to always follow our Code of Conduct*
124
+
Remember, this process helps us maintain code quality while keeping things moving.
125
+
When in doubt, ask for a second opinion!
126
+
And also, be sure to always follow our Code of Conduct.
0 commit comments