Skip to content

Commit 355929d

Browse files
committed
- Standardize title and sidebar label casing in review process documentation.
- Clarify timeline expectations with punctuation. - Enhance clarity in automated checks section. - Improve instructions for handling Vale suggestions. - Update substantial contributions guidelines for clarity and completeness. - Add import statements for Tabs and TabItem components. - Refine contribution planning steps with additional details. - Streamline content structure and improve readability throughout.
1 parent 4dac5e2 commit 355929d

File tree

2 files changed

+90
-126
lines changed

2 files changed

+90
-126
lines changed

docs/contributing/review-process.mdx

Lines changed: 37 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Review Process
3-
description: What to expect when your documentation contribution is reviewed.
4-
sidebar_label: Review Process
2+
title: Review process
3+
description: What to expect when your contribution is reviewed.
4+
sidebar_label: Review process
55
sidebar_position: 6
66
---
77

@@ -13,19 +13,20 @@ Understand what happens after you submit a pull request and how to navigate the
1313

1414
We strive to provide timely feedback:
1515

16-
- **Initial response**: Within 2 business days
17-
- **Complete review**: Within 5 business days for standard contributions
18-
- **Expedited review**: Within 24 hours for critical fixes
16+
- **Initial response**: Within 2 business days.
17+
- **Complete review**: Within 5 business days for standard contributions.
18+
- **Expedited review**: Within 24 hours for critical fixes.
19+
20+
Critical fixes include
1921

20-
**Critical fixes** include:
2122
- Security documentation issues
2223
- Incorrect information that could break user workflows
2324
- Broken links to essential resources
2425
- Major accessibility issues
2526

2627
If you don't receive a response within these timeframes, feel free to:
28+
2729
- Comment on the PR asking for an update
28-
- Ping `@doc-detective/maintainers` in the PR
2930
- Ask in [Discord](https://discord.gg/2M7wXEThfF)
3031

3132
## Automated checks
@@ -44,7 +45,7 @@ Before human review, automated checks verify your contribution.
4445
In your pull request, you'll see status checks:
4546

4647
-**Green check**: Passed
47-
- **Red X**: Failed
48+
- **Red X**: Failed
4849
- 🟡 **Yellow circle**: Running
4950

5051
### If checks fail
@@ -56,18 +57,22 @@ Don't panic! Failed checks are common and usually easy to fix.
5657
Vale checks writing style. Common issues:
5758

5859
**"Use second person instead of first person"**
60+
5961
-`We recommend using...`
6062
-`Use...` or `You can use...`
6163

6264
**"Avoid using 'please' in instructions"**
65+
6366
-`Please click the button`
6467
-`Click the button`
6568

6669
**"Use active voice"**
70+
6771
-`The file can be uploaded by...`
6872
-`Upload the file by...`
6973

7074
**Handling Vale suggestions:**
75+
7176
- **Errors**: Should be fixed
7277
- **Warnings**: Strongly consider fixing
7378
- **Suggestions**: Optional—reviewers use judgment
@@ -78,13 +83,15 @@ If you disagree with a Vale suggestion, explain why in a comment. Reviewers can
7883

7984
Usually indicate syntax errors:
8085

81-
**Common causes:**
86+
Common causes include
87+
8288
- Unclosed code blocks (missing closing ` ``` `)
8389
- Invalid front matter (YAML syntax errors)
8490
- Broken Markdown syntax
8591
- Missing closing tags in JSX
8692

87-
**How to fix:**
93+
How to fix failures:
94+
8895
1. Check the error message for the specific file and line number
8996
2. Fix the syntax error
9097
3. If working locally, run `npm run build` to verify
@@ -94,13 +101,15 @@ Usually indicate syntax errors:
94101

95102
Means a link is broken or inaccessible:
96103

97-
**Common causes:**
104+
Common causes include
105+
98106
- Typo in URL
99107
- Link to a page that doesn't exist yet
100108
- External site is temporarily down
101109
- Case sensitivity issue in path
102110

103-
**How to fix:**
111+
How to fix:
112+
104113
1. Check the error message for which link failed
105114
2. Verify the URL is correct
106115
3. For internal links, ensure the file exists at that path
@@ -185,7 +194,8 @@ Must be addressed before merging:
185194
- **Broken links**: Links that don't work
186195
- **Build failures**: Syntax errors preventing deployment
187196

188-
**How to respond:**
197+
How to respond:
198+
189199
- Fix the issue
190200
- Commit and push changes
191201
- Reply to the comment explaining what you fixed
@@ -199,7 +209,8 @@ Optional improvements:
199209
- **Related content**: Suggestions for future enhancements
200210
- **Style suggestions**: Minor improvements to match conventions
201211

202-
**How to respond:**
212+
How to respond:
213+
203214
- Make the change if you agree
204215
- Or explain why you prefer your approach
205216
- Or note it for future improvement
@@ -212,7 +223,8 @@ Reviewer needs clarification:
212223
- "Can you explain what this code does?"
213224
- "Is this the recommended method?"
214225

215-
**How to respond:**
226+
How to respond:
227+
216228
- Answer the question in a comment
217229
- Consider if the documentation should include this clarification
218230
- Update the docs if the question reveals a gap
@@ -246,7 +258,7 @@ The pull request automatically updates with your new commits.
246258

247259
### Re-requesting review
248260

249-
After addressing feedback:
261+
After addressing feedback, you can re-request review:
250262

251263
1. **Resolve conversations**: Click "Resolve conversation" on addressed comments
252264
2. **Leave unresolved**: Keep conversations open if you have questions
@@ -269,19 +281,19 @@ Most disagreements resolve through discussion.
269281

270282
Congratulations! Your contribution will be merged soon.
271283

272-
**What happens next:**
284+
What happens next:
273285

274286
1. **Maintainer merges**: A maintainer with merge permissions merges your PR
275287
2. **Automatic deployment**: GitHub Actions automatically deploys to production
276288
3. **Live in minutes**: Your changes appear on doc-detective.com within 5-10 minutes
277-
4. **Notification**: You receive a notification that your PR was merged
278289

279290
### After merge
280291

281-
- **Close related issues**: If your PR addresses an issue, it should close automatically
282-
- **Celebrate**: You've contributed to open source! 🎉
283-
- **Share**: Tweet about it, add to your portfolio, tell friends
284-
- **Keep contributing**: Found something else to improve?
292+
Celebrate! 🎉 You've contributed to open source! Post about it, add to your portfolio, tell your friends.
293+
294+
If your PR addresses an issue, it should close automatically.
295+
296+
Found something else to improve? Open another PR!
285297

286298
## Special cases
287299

@@ -339,11 +351,10 @@ Each reviewer may provide feedback. Address all feedback before final approval.
339351

340352
- **Ask in the PR**: Comment asking for clarification
341353
- **Ask in Discord**: [Join the Discord](https://discord.gg/2M7wXEThfF) and ask in #documentation
342-
- **Tag maintainers**: Use `@doc-detective/maintainers` for urgent questions
343354

344355
### Need more time?
345356

346-
Life happens. If you can't address feedback right away:
357+
Life happens. If you can't address feedback right away,
347358

348359
1. **Comment on the PR**: Let reviewers know you'll return to it
349360
2. **Mark as draft**: Convert to draft PR if you need more time
@@ -360,6 +371,6 @@ Life happens. If you can't address feedback right away:
360371

361372
### You're now a contributor!
362373

363-
Thank you for making Doc Detective better. Your contribution, no matter how small, helps thousands of users.
374+
Thank you for making Doc Detective better. Your contribution, no matter how small, helps all of our users.
364375

365376
Every great open source contributor started with one pull request. This is yours. 🌟

0 commit comments

Comments
 (0)