jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 09:57:42 -05:00
Code Issues Projects Releases Wiki Activity

Update the content-linter readme to be LLM-friendly (#58407)

Browse Source
This commit is contained in:
Sarah Schneider
2025-11-07 18:35:48 -05:00
committed by GitHub
parent fb120b3351
commit 8d57be2d01
2 changed files with 112 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/instructions/code.instructions.md vendored
View File

@@ -16,6 +16,7 @@ For code reviews, follow guidelines, tests, and validate instructions. For creat
- Avoid pull requests with over 300 lines of code changed. When significantly larger, offer to split up into smaller pull requests if possible.
- All new code should be written in TypeScript and not JavaScript.
- We use absolute imports, relative to the `src` directory, using the `@` symbol. For example, `getRedirect` which lives in `src/redirects/lib/get-redirect.ts` can be imported with `import getRedirect from '@/redirects/lib/get-redirect'`. The same rule applies for TypeScript (`.ts`) imports, e.g. `import type { GeneralSearchHit } from '@/search/types'`
- For updates to the content linter, read important information in `src/content-linter/README.md`.
## Tests