Skip to content

Commit 6d56c50

Browse files
committed
docs: fix linting
1 parent 542fa97 commit 6d56c50

File tree

2 files changed

+20
-15
lines changed

2 files changed

+20
-15
lines changed

src/content/docs/project/development.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ 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.
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,
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,
2727
asides, and other interactive elements easily.
2828

2929
<Aside title="Helpful Links">

src/content/docs/project/maintain.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: maintain
3-
title: Maintaining the project
3+
title: Maintaining the project
44
sidebar_label: Help us Improve
55
---
66

@@ -27,6 +27,7 @@ Before merging any PR (except all-contributors bot PRs), make sure:
2727
### One approval required
2828

2929
Most PRs fall here:
30+
3031
* Documentation updates
3132
* Small bug fixes
3233
* Maintenance work
@@ -35,6 +36,7 @@ Most PRs fall here:
3536
### Two approvals required
3637

3738
For large or sensitive changes such as:
39+
3840
* API changes
3941
* Major refactors
4042
* Significant security fixes
@@ -49,7 +51,8 @@ For large or sensitive changes such as:
4951
### Format the squash commit message
5052

5153
Follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
52-
```
54+
55+
```none
5356
<type>(<scope>): <description>
5457
5558
[optional body]
@@ -58,6 +61,7 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
5861
```
5962

6063
**Common types:**
64+
6165
* `feat:`: New feature
6266
* `fix:`: Bug fix
6367
* `docs:`: Documentation changes
@@ -83,6 +87,7 @@ chore(deps): bump tailwindcss from 4.17.20 to 4.17.21
8387
### Why squash merge?
8488

8589
We use the squash-merge approach because it provides:
90+
8691
* **Clean history**: One commit per PR makes the history easy to read
8792
* **Meaningful commits**: Each commit represents a complete feature or fix
8893
* **Easy reverts**: Can revert an entire feature with one command
@@ -93,29 +98,29 @@ We use the squash-merge approach because it provides:
9398
As a maintainer, please avoid merging your own PRs when possible. Having another set of eyes review is good practice!
9499

95100
**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
98104

99105
## After Merging
100106

101107
### Add contributors to the all-contributors table
102108

103109
When you merge a PR, add the contributor using this command:
104-
```
110+
111+
```none
105112
@all-contributors please add <github-username> for <contribution-roles>
106113
```
107114

108115
Contributors are asked to do this themselves, but they often forget. Please check and add them if needed!
109116

110117
**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.
111118

112-
113-
114119
## Need Help with Reviews?
115120

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
120123

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

Comments
 (0)