Skip to content

Commit 2f34845

Browse files
committed
Update Cursor Project Rule Editor with Enhanced Formatting and Critical Warning
- Refine `.mdc` file formatting guidelines - Add critical warning about file initialization bug when creating/editing `.mdc` files - Update description and globs configuration - Improve frontmatter and link formatting recommendations - Enhance rule documentation with more precise instructions
1 parent b3f0811 commit 2f34845

20 files changed

+832
-22
lines changed

.cursor/rules/cursor-project-rule-editor.mdc

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
versionNum: 7a0e5aab
3-
description: How to Edit Cursor Rules and their appropriate location in the repository
4-
globs:
2+
versionNum: b2fe3ee5
3+
description: Editing Cursor Project Rules
4+
globs: *.mdc
55
source: https://gist.github.com/codekiln/242b572c64c1097277fd4c831db91c10
66
---
77
# Cursor Project Rule Editor Rule
88

9-
`.mdc` files stand for Mark Down Cursor, and are meant to give the Cursor IDE AI Agent context on how to operate in the codebase.
9+
`.mdc` files stand for MarkDown Cursor, and are meant to give the Cursor IDE AI Agent context on how to operate in the codebase.
1010
This particular rule is about using the AI to author and edit `.mdc` files, so as to update the rules.
1111
This rule ensures `.mdc` files are correctly placed within a repository and adhere to standard formatting conventions.
1212

@@ -61,11 +61,20 @@ actions:
6161
└── ...
6262
```
6363

64-
4. Never place rule files:
64+
4. VERY IMPORTANT - NEVER EVER place rule files:
6565
- In the project root
6666
- In subdirectories outside .cursor/rules
6767
- In any other location
6868

69+
5. ⚠️ CRITICAL WARNING - File Initialization Bug:
70+
When the AI creates or edits a .mdc file, DO NOT open the file in the editor
71+
until the changes are committed to the repository. There is currently a bug
72+
where opening a newly created or edited .mdc file in the editor will cause
73+
it to be initialized/erased. To avoid this:
74+
- Wait for the AI to finish making changes
75+
- Commit the changes to the repository
76+
- Only then open the file in the editor if needed
77+
6978
examples:
7079
- input: |
7180
# Bad: Rule file in wrong location
@@ -100,28 +109,32 @@ actions:
100109
message: |
101110
Markdown `.mdc` files should:
102111

103-
1. **Include a frontmatter block** at the top with a `description` field:
112+
1. **Include a frontmatter block** at the top with `description` and `globs` fields:
104113
```
105114
---
106-
description: "Description of the rule"
107-
globs: "*.mdc"
115+
description: <REQUIRED: RULE_DESCRIPTION_HERE>
116+
globs: <OPTIONAL: COMMA_SEPARATED_GLOBS_HERE>
108117
---
109118
```
119+
RULE_DESCRIPTION_HERE: the phrase placed here is like a "wake word" for the AI agent to use this agent. This is required of all cursor rules.
120+
COMMA_SEPARATED_GLOBS_HERE: if a file is being edited that matches the given glob relative to the project root (.gitignore syntax), then this rule will be activated. This acts as a gate - globs are filled in, then the rule likely won't be activated unless it matches a glob. If the globs are not filled in, then it may be activated if the description sounds like a relevant tool to the current task to the AI agent.
110121

111-
2. **Use `mdc:` links** for file references, constructing a relative link from the PROJECT_ROOT to the file
122+
2. **Use `mdc:` links** for file references, constructing a relative link from the PROJECT_ROOT to the file. The following is a link to a file at PROJECT_ROOT/src/folder/example.txt
112123
```
113-
[example.mdc](mdc:.cursor/rules/example.mdc)
124+
[example.txt](mdc:src/folder/example.txt)
114125
```
115126

116127
3. **Use proper headers** (`#`, `##`, `###`) and avoid inconsistent formatting.
117128

118129
examples:
119130
- input: |
120131
---
121-
description: "Example rule for formatting"
132+
description: Example rule for formatting
133+
globs: *.mdc
122134
---
123135
# Sample Rule
124136
This rule enforces correct `.mdc` formatting.
137+
(...)
125138
output: "Correctly formatted `.mdc` file"
126139

127140
metadata:

journals/2025_03_02.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@
3636
- [[Knowledge Gardening]]
3737
- [[Package Management]]
3838
- [[Stoic]]
39+
- ## #Typography
40+
- [[Font/nerdfonts]] [Nerd Fonts - Iconic font aggregator, glyphs/icons collection, & fonts patcher](https://www.nerdfonts.com/)
3941
- ## #Unicode
40-
- [[Font/unscii]]
41-
- [[Unicode/Block/Symbols for Legacy Computing]]
42+
- #Filed
43+
- [[Font/unscii]]
44+
- [[Semigraphics/Sextant Character]]
45+
- [[Semigraphics/Sextant Characters/Py Grid Utility]]
46+
- ### [[Unicode/Block/Symbols for Legacy Computing]]
47+
- {{embed ((67c4c0b2-af03-4de6-ae00-405849fc19cd))}}
48+
- [[Unicode/Block/Symbols for Legacy Computing/Ref]]

journals/2025_03_03.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## [[AI Coding]]
2+
- [[AI/Coding/Technique/Phased Planning/ai-coding dir]] #Updated
3+
- Expanded the introductory section with a description of the files in the directory and some examples of various ticket folders
4+
- Thinking that it might make sense to add these, but haven't recorded this anywhere else yet
5+
- plan and checklist files for each stage in sub-folders to increase focus
6+
- a file for CURRENT STAGE to store that state
7+
- subfolders for issues from other repos
8+
- [[CursorAI/Security/How To/Exclude Secrets from Indexing]]
9+
- [[CursorAI/Forum/24/12/Questions on .gitignore, .cursorignore, .cursorban]]
10+
- Expense of [[Claude 3.7 Sonnet]]
11+
- [Is using claude-sonnet-3.7 more expensive than normal? : r/cursor](https://www.reddit.com/r/cursor/comments/1ixy6ip/is_using_claudesonnet37_more_expensive_than_normal/)
12+
- Yes, it's fairly expensive. I'm using [[IDE/Cline]] extension in [[Windsurf]] and have spent $1.30 with 5 minutes. If you use it for a full day you could easily spend between 50 and 100 dollars.
13+
- #[[Tiling Window Manager]]
14+
- [What’s the best window manager? : r/macapps](https://www.reddit.com/r/macapps/comments/1arq5a6/whats_the_best_window_manager/)
15+
- 31 upvotes for [[MacOS/Tiling/App/Rectangle]], which is what I currently use, but it doesn't have all the features I want. I really could benefit from learning more of the keyshorts, though. Unbelievably, even though it has many features I don't use, it doesn't have the features I want. I'd really like to have more of a window manager like [[awesomeWM]] when I was in linux. I'd love to be able to snap and pin tiny applications to a small dedicated section of the screen. I think I can do that with [[BentoBox]].
16+
- 30 upvotes [[Mac/Tiling/App/Swish]]
17+
- {{embed ((67c57577-3534-41bf-a123-dc60b5d4f7d6))}}
18+
- 3 upvotes for [[Mac/Tiling/App/BentoBox]]
19+
- {{embed ((67c5750d-d643-4175-918f-fd25893710dc))}}

pages/AI___Coding___Technique___Phased Planning___ai-coding dir.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
11
# AI Coding technique - Using an `.ai-coding/TICKET/` dir for staging [[SDLC]] planning artifacts by SDLC Phase
22
- ## Summary of the `/.ai-coding/TICKET-feature-name/` directory
33
id:: 67c180c4-95f6-4d0b-b787-60d11eed3ff9
4-
- Named after the ticket and a brief description of the feature; preferably the name of this directory matches the end of the branch name; `TICKET` is an external project management ticket reference from [[JIRA]], [[GitHub/Issue]], [[Gitlab/Issue]], [[JetBrains/YouTrack]], etc, so something like `ASDF-123` for Jira
5-
- Contains all planning and documentation assets for a single feature's implementation. Here they are, broken down by the **Phase** in which they are created or used.
4+
- Named after the ticket and a brief description of the feature; preferably the name of this directory matches the end of the branch name; `TICKET` is an external project management ticket reference.
5+
- ### Examples of `TICKET` references
6+
- [[JIRA]] - `ASDF-123`
7+
- [[GitHub/Issue]] - by convention, `gh-issue-123` for an issue in the current repo
8+
- [[Gitlab/Issue]] - by convention, `gl-issue-123` for an issue in the current repo
9+
- This directory contains all planning and documentation assets for a single feature's implementation. Here's an example full directory with all files for a github issue:
10+
- `/.ai-coding/gl-issue-123-feature-name/`
11+
- [[AI/Coding/v0/File/1-TICKET-original-issue.md]]
12+
- [[AI/Coding/v0/File/1-TICKET-repomix.config.json]]
13+
- [[AI/Coding/v0/File/2-TICKET-technical-specification.md]]
14+
- [[AI/Coding/v0/File/3-TICKET-staged-implementation-plan.md]]
15+
- [[AI/Coding/v0/File/6-TICKET-staged-implementation-checklist.md]]
16+
- [[AI/Coding/v0/File/6-TICKET-qa-todo.md]]
17+
- [[AI/Coding/v0/File/6-TICKET-qa-summary.md]]
18+
- [[AI/Coding/v0/File/7-TICKET-mr-summary.md]]
19+
- [[AI/Coding/v0/File/8-TICKET-mr-handoff.md]]
20+
- ## Phases and their [[Intermediate Packets]] AKA output files
621
- ### [[AI/Coding/v0/Phase/0 - Preparation]]
722
id:: 67c2d185-4821-4b6f-80f9-51b05cdb859e
8-
- Before beginning work on a ticket, even before assembling materials to work on the ticket, it helps to have a the coding environment is correctly configured. This includes but is not limited to:
23+
- Before beginning work it is a good idea to prepare the coding environment for AI coding. This includes but is not limited to:
924
- downloading the repository
1025
- setting up the IDE
1126
- ensuring that [[Prompts]] for [[AI Coding]] are configured and accessible

pages/Ableton___Packs___building-max-devices___02_M4L_Intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- ## DONE Page 2/9 - [[Ableton/Max for Live/MIDI Effect/Note Doubler]] in "Track 1 Max Patching"
66
id:: 67960248-7168-46b2-af54-5ecfa125cfd6
77
collapsed:: true
8-
- so many [[Nerd Safari]]s await
8+
- so many [[Nerd/Safari]]s await
99
- [[c74/max/Time Value Syntax]]
1010
collapsed:: true
1111
- Here is a listing of the note and tick values associated with common note durations. Note value abbreviations that can be used in Max to specify time are in bold.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
date-created:: [[2024/12]]
2+
3+
- # [Questions on .gitignore, .cursorignore, .cursorban - Feedback - Cursor - Community Forum](https://forum.cursor.com/t/questions-on-gitignore-cursorignore-cursorban/34713)
4+
-

pages/Font___nerdfonts.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
alias:: [[nerdfonts]]
2+
3+
- # [Nerd Fonts - Iconic font aggregator, glyphs/icons collection, & fonts patcher](https://www.nerdfonts.com/)
4+
-
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
alias:: [[BentoBox]]
2+
3+
- # [macOS Window Manager | BentoBox 🍱](https://bentoboxapp.com/)
4+
- ## [[My Notes]]
5+
id:: 67c5750d-d643-4175-918f-fd25893710dc
6+
- #Price - $9 right now, $20 once they are at v1.0
7+
- #Cool - let's you pick your layouts to snap to
8+
- https://assets.bentoboxapp.com/bentobox-demo.mp4
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# [Swish for macOS](https://highlyopinionated.co/swish/)
2+
- ## [[My Notes]]
3+
id:: 67c57577-3534-41bf-a123-dc60b5d4f7d6
4+
- #Price $16
5+
- Very based on [[Trackpad/Gestures]]
6+
- Trailer
7+
- https://highlyopinionated.co/swish/media/trailer.mp4

pages/Nerd___Safari.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
alias:: [[Nerd Safari]]

0 commit comments

Comments
 (0)