@@ -5,11 +5,11 @@ sidebar_label: Maintainer Processes
55---
66import { Aside } from ' @astrojs/starlight/components' ;
77
8- This guide walks you, as a maintainer, through reviewing and merging pull
8+ This guide walks you, as a maintainer, through reviewing and merging pull
99requests. We've organized it to follow the typical GitHub Pull Request (PR) workflow.
1010
11- To begin, all pull requests should come from a forked repository, not from branches in
12- the main repo (with the exception of Dependabot security updates and
11+ To begin, all pull requests should come from a forked repository, not from branches in
12+ the main repo (with the exception of Dependabot security updates and
1313all-contributor bot PRs).
1414
1515## Before You Merge - Quick Checklist
@@ -42,7 +42,7 @@ Most PRs fall here:
4242
4343### Two approvals required
4444
45- In some cases we may want a more thorough review and multiple maintainers
45+ In some cases we may want a more thorough review and multiple maintainers
4646involved in a review.
4747Please seek two approvals (if possible) for large or sensitive changes such as:
4848
@@ -51,25 +51,26 @@ Please seek two approvals (if possible) for large or sensitive changes such as:
5151* Significant security fixes
5252* Changes affecting the bot's API and our users
5353
54- <Aside type = " tip" >For larger changes, please open an issue to discuss
54+ <Aside type = " tip" >For larger changes, please open an issue to discuss
5555the design before submitting the PR.</Aside >
5656
57- ### Maintainer Feedback & New Issues
57+ ### Maintainer Feedback & New Issues
5858
59- We value an fluid and agile development process here at the all-contributors bot. If you
59+ We value an fluid and agile development process here at the all-contributors bot. If you
6060find an issue during the review that is outside the scope of the PR,
61- please create a new issue to track it instead of blocking the PR from being
62- merged. This allows us to keep the project moving forward and also preserves
61+ please create a new issue to track it instead of blocking the PR from being
62+ merged. This allows us to keep the project moving forward and also preserves
6363precious volunteer maintainer time.
6464
65- If a PR is merged but you you'd like to see a follow-up PR that adjusts things,
66- no worries, simply open an issue about that follow-up and submit a new PR, if
65+ If a PR is merged but you you'd like to see a follow-up PR that adjusts things,
66+ no worries, simply open an issue about that follow-up and submit a new PR, if
6767needed.
6868
6969## Merging PRs: Use Squash and Merge
7070
71- Always use "Squash and Merge" when you merge a PR. Combined with angular commit
71+ Always use "Squash and Merge" when you merge a PR. Combined with angular commit
7272conventions, squash and merge will keep our commit history clean and meaningful.
73+
7374### Why squash merge?
7475
7576We use the squash-merge approach because it provides:
@@ -111,12 +112,12 @@ docs(readme): update installation instructions
111112chore(deps): bump tailwindcss from 4.17.20 to 4.17.21
112113```
113114
114- <Aside type = " tip" >The scope is optional but helpful. Use it to indicate what
115+ <Aside type = " tip" >The scope is optional but helpful. Use it to indicate what
115116part of the project changed (e.g., ` api ` , ` cli ` , ` docs ` , ` tests ` ).</Aside >
116117
117118## Merging Your Own PRs
118119
119- As a maintainer, please avoid merging your own PRs when possible. Having another
120+ As a maintainer, please avoid merging your own PRs when possible. Having another
120121set of eyes review your work is good practice!
121122
122123** If you must self-merge** (urgent/security/critical fix):
@@ -128,32 +129,32 @@ set of eyes review your work is good practice!
128129
129130### Add contributors to the all-contributors table
130131
131- When you merge a PR that is not yours, be sure to add the contributor using
132+ When you merge a PR that is not yours, be sure to add the contributor using
132133our friendly all-contributors bot ✨:
133134
134135``` none
135136@all-contributors please add <github-username> for <contribution-roles>
136137```
137138
138- We ask contributors to do this themselves, but they often forget or are not
139- comfortable doing so. Please check that they have added themselves, and if not,
140- add them if needed! If they have added themselves be sure to merge the
139+ We ask contributors to do this themselves, but they often forget or are not
140+ comfortable doing so. Please check that they have added themselves, and if not,
141+ add them if needed! If they have added themselves be sure to merge the
141142associated all-contributors PR!
142143
143144<Aside type = " note" >
144- If the contributor is already listed for that contribution type
145+ If the contributor is already listed for that contribution type
145146(e.g., they're already in the table for ` bug ` ), you don't need to add them again.
146147</Aside >
147148
148149## Need Help with Reviews?
149150
150- If you are waiting on a PR that you submitted and no one has responded or left
151- you a review:
151+ If you are waiting on a PR that you submitted and no one has responded or left
152+ you a review:
152153
153154* Ping maintainers who've been active on related issues
154155* As a last resort, ping the ` @maintainers ` team
155156
156- Remember, this process helps us maintain code quality while keeping things
157+ Remember, this process helps us maintain code quality while keeping things
157158our friendly bot's documentation and infrastructure moving forward.
158159When in doubt, ask for a second opinion!
159160
0 commit comments