Skip to content

Commit 1902a36

Browse files
committed
chore: improve repo contribution instructions
1 parent 96e5987 commit 1902a36

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,36 @@ git checkout -b <branch-name>
1717
### 3. Make Changes in the Appropriate Page
1818
Navigate to the relevant documentation page in the repository and make your changes. Ensure that your changes align with our style guide and maintain consistency across the documentation.
1919

20-
### 4. Raise a Pull Request (PR)
20+
### 4. Preview your changes
21+
Make sure you are visually happy with your changes.
22+
23+
1. Run `npx mint dev`
24+
1. A url will be printed to your console. Open it in your browser.
25+
1. Visit your pages and confirm they look correct.
26+
27+
### 5. Fix broken links
28+
29+
1. Run `npx mint broken-links`
30+
2. Fix all reported broken links
31+
32+
### 5. Raise a Pull Request (PR)
2133
Once your changes are ready, raise a pull request (PR) to merge your branch into the `master` branch. Please provide a descriptive title and detailed description of your changes.
2234

23-
### 5. Leave a Clear Commit Message
35+
### 6. Leave a Clear Commit Message
2436
When committing your changes, leave a clear and concise message that links to the corresponding issue (if applicable) and explains the fix or enhancement you've made.
2537

2638
```bash
2739
git add .
2840
git commit -m "Fixes #<issue-number>: Description of the fix or enhancement"
2941
```
3042

31-
### 6. Link the Issue to the Pull Request
43+
### 7. Link the Issue to the Pull Request
3244
In your pull request description, be sure to reference the related issue using GitHub's syntax (`#<issue-number>`). This links the PR to the issue and helps maintain context.
3345

34-
### 7. Sign the Contributor License Agreement (CLA)
46+
### 8. Sign the Contributor License Agreement (CLA)
3547
Before we can merge your contribution, you must sign our contributor license agreement (CLA). This agreement ensures that your contributions comply with our licensing terms.
3648

37-
### 8. Assign a Reviewer from Our Team
49+
### 9. Assign a Reviewer from Our Team
3850
Once your PR is submitted, a member of our team will be assigned to review your changes. They will provide feedback and may request revisions if necessary. Please respond promptly to any review comments to expedite the merging process.
3951

40-
Thank you for contributing to our documentation! We appreciate your efforts in making our product documentation more comprehensive and user-friendly. If you have any questions or need assistance, feel free to reach out to our team. Happy contributing!
52+
Thank you for contributing to our documentation! We appreciate your efforts in making our product documentation more comprehensive and user-friendly. If you have any questions or need assistance, feel free to reach out to our team. Happy contributing!

0 commit comments

Comments
 (0)