Skip to content

Commit e1f0a19

Browse files
committed
docs: add page on pr merge governance
1 parent e0c43b3 commit e1f0a19

File tree

3 files changed

+78
-1
lines changed

3 files changed

+78
-1
lines changed

astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ export default defineConfig({
6464
items: [
6565
{ label: 'contribute', slug: 'project/contribute' },
6666
{ label: 'development', slug: 'project/development' },
67+
{ label: 'maintain', slug: 'project/maintain' },
6768
{ label: 'code-of-conduct', slug: 'project/code-of-conduct' },
6869
{ label: 'implementations', slug: 'project/implementations' },
6970
],

src/content/docs/project/development.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ It handles navigation, search, dark mode, and supports [Tailwind CSS](https://ta
2121

2222
## MDX Files
2323

24-
Our documentation pages are largely written using the **MDX** (`.mdx`) format. This format supports Markdown with the additional ability to include components and custom elements directly in the content. This allows us to embed images, asides, and other interactive elements easily.
24+
Our documentation pages are largely written using the **MDX** (`.mdx`) format.
25+
This format supports Markdown with the additional ability to include components
26+
and custom elements directly in the content. This allows us to embed images,
27+
asides, and other interactive elements easily.
2528

2629
<Aside title="Helpful Links">
2730
* [Starlight Documentation](https://starlight.astro.build/guides/introduction/)
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
id: maintain
3+
title: Maintaining the project
4+
sidebar_label: Help us Improve
5+
---
6+
7+
This guide walks you through reviewing and merging pull requests. We've organized it to follow the typical GitHub Pull Request workflow.
8+
9+
## Before You Merge - Quick Checklist
10+
11+
Before merging any PR (except all-contributors bot PRs), make sure:
12+
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
19+
20+
## PR Approval Requirements
21+
22+
### No approval required
23+
24+
- **All-contributors bot PRs** - Any maintainer can merge without approval
25+
- **Dependabot PRs** - Any maintainer can merge once CI is green
26+
27+
### One approval required
28+
29+
Most PRs fall here:
30+
- Documentation updates
31+
- Small bug fixes
32+
- Maintenance work
33+
- Non-breaking changes
34+
35+
### Two approvals required
36+
37+
For large or sensitive changes:
38+
- API changes
39+
- Major refactors
40+
- Significant security fixes
41+
- Changes affecting many consumers
42+
43+
💡 **Tip:** For these larger changes, please open an issue to discuss the design before submitting the PR.
44+
45+
## Merging Your Own PRs
46+
47+
As a maintainer, please avoid merging your own PRs when possible. Having another set of eyes review is good practice!
48+
49+
**If you must self-merge** (urgent/security/critical fix):
50+
- Request a quick review if someone is available, OR
51+
- Leave a note in the PR explaining why you're self-merging
52+
53+
## After Merging
54+
55+
### Add contributors to the all-contributors table
56+
57+
When you merge a PR, add the contributor using this command:
58+
```
59+
@all-contributors please add <github-username> for <contribution-roles>
60+
```
61+
62+
Contributors are asked to do this themselves, but they often forget. Please check and add them if needed!
63+
64+
**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.
65+
66+
## Need Help with Reviews?
67+
68+
- Ping maintainers who've been active on related issues
69+
- As a last resort, carefully ping the `@maintainers` team
70+
71+
---
72+
73+
*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*

0 commit comments

Comments
 (0)