Jon/cursor rules #5735
Open
Jon/cursor rules #5735
+57
−53
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a small subset of the rules that are specific to this repo
samholmes
requested changes
Sep 10, 2025
| @@ -0,0 +1,4 @@ | |||
| --- | |||
| description: Before installing a package, read the npm or github page first to check if there is anything suspicious: first publish date, I in place of L, number of stars, etc. Respond with a link to the package first, and wait for user confirmation to install. | |||
There was a problem hiding this comment.
What does i in place of l mean?
There was a problem hiding this comment.
Uppercase I looks like a lowercase l
| @@ -0,0 +1,4 @@ | |||
| --- | |||
| description: String literals should always be defined in and referenced from @en_us.ts | |||
There was a problem hiding this comment.
This should be scoped to rendering of components in JSX for a component or a string that's displayed.
| @@ -0,0 +1,4 @@ | |||
| --- | |||
| description: JSX props shouldn't use inline arrow functions, but utilize `useHandler` appropriately. | |||
There was a problem hiding this comment.
The exception is if the handler is perhaps a prop or some other defined function.
Comment on lines
+176
to
+185
| - Use ?? instead of || for default values. ?? only treats null/undefined as missing, || treats all falsy values as missing: | ||
| ❌ value || defaultValue → ✅ value ?? defaultValue | ||
| ❌ config.timeout || 5000 → ✅ config.timeout ?? 5000 (preserves 0) | ||
| ❌ user.name || 'Anonymous' → ✅ user.name ?? 'Anonymous' (preserves '') | ||
| ❌ settings.enabled || true → ✅ settings.enabled ?? true (preserves false)" | ||
| - NEVER use optional chaining results directly in conditions: | ||
| ❌ `if (obj?.prop)` → ✅ `if (obj?.prop != null)` | ||
| ❌ `if (obj?.arr?.length > 0)` → ✅ `if (obj?.arr != null && obj.arr.length > 0)` | ||
| ❌ `if (response?.data)` → ✅ `if (response?.data != null)` | ||
| - Component exports for any modified files should follow the form: `export const Component: React.FC<Props> = (props: Props) => {` |
There was a problem hiding this comment.
This is redundant and should be handled by the linter. So you can summarize this as the agent should use the linter rules.
Comment on lines
+190
to
+194
| - Background tasks (yarn dev, yarn start, etc) should be checked if running before attempting to start. Don't run these types of background tasks unless explicitly asked to do so. | ||
| - After completing code changes, run `yarn tsc` and fix any errors. Once those are addressed, run `files=($(git diff HEAD --name-only -- '*.ts' '*.tsx')); if (( ${#files} )); then ./node_modules/.bin/eslint --fix "${files[@]}"; else echo "No TS/TSX changes since HEAD."; fi` after your changes, and manually fix any non-deprecation warnings that cannot be automatically fixed, if necessary. It is not necessary to fix any lint warnings/errors on files that you did not modify yourself. | ||
| - Multi-phase plans should always be done one phase at a time before stopping and asking for feedback. | ||
| - Never start work when I mention "Come up with a plan" or similar. Such a request is literally to come back with a textual plan. | ||
| - Before using any code editing tools (edit_file, search_replace, etc.), scan my entire message for questions (?). If ANY exist, you MUST answer all questions first without making code changes. Only proceed with implementation after I permit you to in a follow-up message. |
There was a problem hiding this comment.
This seems like content that should go in an AGENTS.md file, not README.md.
Comment on lines
+198
to
+199
| - Before installing a package, read the npm or github page first to check if there is anything suspicious: first publish date, I in place of L, number of stars, etc. Respond with a link to the package first, and wait for user confirmation to install. | ||
| - RESEARCH FIRST: Before implementing external APIs or libraries, you MUST either quote provided documentation or actively search for official documentation using available tools. Always explicitly state 'According to [source]...' when making implementation decisions. If documentation searches are incomplete or missing critical details: 1. STOP implementation immediately 2. ASK: 'I found [what I found] but need [specific missing details]. Would you like me to search more thoroughly, or can you provide the documentation?' 3. WAIT for user guidance before proceeding" |
There was a problem hiding this comment.
This could be appropriate for README.md as "# Contributions" section. But you can leave it as is for an agent md file.
Comment on lines
+201
to
+209
| ### Communication | ||
|
|
||
| - ALWAYS respond with a neutral tone, without fluff like "Certainly!" or "Perfect." NEVER apologize, but state your understanding of mistakes. | ||
| - CRITICAL: User is human and prone to mistakes. 1. Suggest better approaches if you can think of them before implementing prompted suboptimal solutions. Bring these up as suggestions to yes/no confirm by the user before actually implementing them. 2. Ask for clarification when prompt/question/task is unclear or ambiguous 3. Notify user: if technical inaccuracies present, better alternative approaches/patterns exist, best practices contradicted, edge cases missed, or inconsistencies are found against the code base. | ||
|
|
||
| ### Documentation | ||
|
|
||
| - Update the CHANGELOG with at most a few new entries for the changes made in the current branch, if requested. Entries should ONLY describe the final state of all the current branch changes, NOT the journey or internal conversations, and follow the existing patterns for length and formatting (including no word wrapping). | ||
| - Code comments should ONLY describe the final state of the branch changes, NOT the journey or internal conversations |
There was a problem hiding this comment.
Mostly agent md file belonging, but some can be for a Contribution section in the README.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CHANGELOG
Does this branch warrant an entry to the CHANGELOG?
Dependencies
noneRequirements
If you have made any visual changes to the GUI. Make sure you have: