Skip to content

Commit 524161a

Browse files
committed
Add note about check_links.py
1 parent 55a93b5 commit 524161a

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ This documentation is consumed by AI assistants, so every token counts:
6060
- Update `PINECONE.md` navigation when adding files
6161
- Keep related content together
6262

63+
### Link Verification
64+
65+
If your changes add or modify any URLs:
66+
67+
- **Run the link checker**: `python3 utils/check_links.py --recursive`
68+
- **Fix broken links** before submitting
69+
- See `utils/README_check_links.md` for usage details
70+
6371
## Testing
6472

6573
**Critical**: All changes must be tested with an actual coding assistant to verify the instructions work.
@@ -100,6 +108,7 @@ This documentation is consumed by AI assistants, so every token counts:
100108
- [ ] Assistant provides accurate information
101109
- [ ] No confusion or incorrect guidance observed
102110
- [ ] Code examples work when tested
111+
- [ ] URLs verified (if any URLs were added/modified): `python3 utils/check_links.py --recursive`
103112

104113
## Pull Request Process
105114

@@ -118,7 +127,14 @@ This documentation is consumed by AI assistants, so every token counts:
118127
- Verify markdown renders correctly
119128
- Test code examples
120129
- **Test with a coding assistant** (required)
121-
- Check for broken links
130+
- **Check URLs** - If you added or modified any URLs, verify them using `utils/check_links.py`:
131+
```bash
132+
python3 utils/check_links.py --recursive
133+
```
134+
Or check specific files:
135+
```bash
136+
python3 utils/check_links.py --files path/to/file.md
137+
```
122138

123139
4. **Commit**:
124140

0 commit comments

Comments
 (0)