Skip to content

Commit cf50ebb

Browse files
authored
Merge pull request #327 from knockout/docs/always-improve
Add 'Always Improve' principle to AGENTS.md
2 parents e4441a3 + 9e7c413 commit cf50ebb

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,19 @@ When validating `tko.io` documentation changes with the local docs site:
170170
- Treat docs example work as incomplete until the emitted playground payload compiles cleanly on the live site.
171171
- If a page has multiple TSX examples, check every TSX playground button, not just the first one.
172172

173+
## Always Improve
174+
175+
Leave the codebase a little better than you found it. When you touch a file, fix small nearby issues if they're low-risk and in-scope:
176+
177+
- Typos in comments or JSDoc
178+
- Dead code or unused imports
179+
- Stale comments referring to renamed or removed APIs
180+
- A missing test that would have caught the bug you're fixing
181+
182+
When a feedback loop fails, fix the loop — not just the symptom. Examples: `bun run test` passing locally while CI fails, a confusing script error, a flaky assertion that hides real bugs. Fold the missing check into the local command so the next contributor doesn't hit the same wall.
183+
184+
Avoid scope creep. If an improvement would balloon the PR, file a follow-up issue or spawn a separate task instead.
185+
173186
## Important Guidelines
174187

175188
- Do not modify `tools/build.ts` or `vitest.config.ts` without understanding

0 commit comments

Comments
 (0)