chore: consolidate cursor rules to AGENTS.md #529
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR consolidates multiple .cursor/rules/*.mdc files into a single AGENTS.md file at the repository root. This simplifies maintenance by providing a unified source of AI coding standards that works with both Cursor and GitHub Copilot for consistent code reviews and assistance.
Key changes:
- Merges 9 separate rule files into one comprehensive document
- Removes
.cursor/rules/directory structure - Creates standardized format compatible with multiple AI tools
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | New consolidated coding standards document combining all previous rule files |
| .cursor/rules/ui-patterns.mdc | Deleted - content migrated to AGENTS.md |
| .cursor/rules/typescript-patterns.mdc | Deleted - content migrated to AGENTS.md |
| .cursor/rules/testing-patterns.mdc | Deleted - content migrated to AGENTS.md |
| .cursor/rules/project-structure.mdc | Deleted - content migrated to AGENTS.md |
| .cursor/rules/mcp-patterns.mdc | Deleted - content migrated to AGENTS.md |
| .cursor/rules/gitCommitConventions.mdc | Deleted - content migrated to AGENTS.md |
| .cursor/rules/deferToPrettier.mdc | Deleted - content migrated to AGENTS.md |
| .cursor/rules/cli-commands.mdc | Deleted - content migrated to AGENTS.md |
| .cursor/rules/api-client.mdc | Deleted - content migrated to AGENTS.md |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| ### Test Framework | ||
|
|
||
| - Test runner: Vitest |
There was a problem hiding this comment.
The test framework specified as 'Vitest' conflicts with the deleted testing-patterns.mdc file which stated the framework is 'Mocha with Chai assertions'. This appears to be an incorrect migration of the testing framework information.
| - Test runner: Vitest | |
| - Test runner: Mocha with Chai assertions |
| - Create PR: `av pr --title "<title>" --body "<body>"` | ||
| - Title follows Conventional Commits, body uses markdown/bullets | ||
| - `av pr` will push the branch | ||
| - GitHub PR descriptions should be short and focus on why changes were made, not what changed, limit describing files and tests changed. |
There was a problem hiding this comment.
[nitpick] The sentence structure is unclear. Consider rephrasing to: 'GitHub PR descriptions should be short and focus on why changes were made rather than what changed. Limit descriptions of files and tests changed.'
| - GitHub PR descriptions should be short and focus on why changes were made, not what changed, limit describing files and tests changed. | |
| - GitHub PR descriptions should be short and focus on why changes were made rather than what changed. Limit descriptions of files and tests changed. |
Consolidates
.cursor/rules/*.mdcfiles into singleAGENTS.mdat repo root. This format is supported by both Cursor and GitHub Copilot, providing a single source of truth for AI coding standards. Simplifies maintenance and enables GitHub Copilot to use the same rules for PR reviews.