Skip to content

Commit 46d2199

Browse files
Clarify README editing guidance
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
1 parent 6c8485b commit 46d2199

5 files changed

Lines changed: 13 additions & 1 deletion

File tree

.evidence/after.png

22.6 KB
Loading

.evidence/before.png

21.3 KB
Loading

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ npm run dev
99

1010
## Notes
1111

12-
- [App.svelte](https://github.com/fastrepl/contextlengthof/blob/main/src/App.svelte) is all you need to edit.
12+
- Start with [App.svelte](https://github.com/fastrepl/contextlengthof/blob/main/src/App.svelte) for most UI changes.
1313
- [PicoCSS](https://picocss.com/) is used for styling.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"build": "vite build",
99
"preview": "vite preview",
1010
"check": "svelte-check --tsconfig ./tsconfig.json",
11+
"check:readme": "node scripts/check-readme-phrasing.mjs",
1112
"format": "prettier --write ."
1213
},
1314
"devDependencies": {

scripts/check-readme-phrasing.mjs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { readFileSync } from 'node:fs';
2+
3+
const readme = readFileSync(new URL('../README.md', import.meta.url), 'utf8');
4+
const unclearPhrase = 'is all you need to edit';
5+
6+
if (readme.includes(unclearPhrase)) {
7+
console.error(`README uses overly broad guidance: "${unclearPhrase}"`);
8+
process.exit(1);
9+
}
10+
11+
console.log('README phrasing check passed.');

0 commit comments

Comments
 (0)