SyncytiumMD / rules
Cursor rule6 starsChanged 7 days agoMITView on GitHub
Enforce clean, readable, modern standards across the project
Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 4,183 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository11 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/adapter-standards.mdcCursor rule
- .cursor/rules/release-criteria.mdcCursor rule
- .cursor/rules/security.mdcCursor rule
- .cursor/rules/syncytium-architecture.mdcCursor rule
- .cursor/rules/syncytium-handoff.mdcCursor rule
- .cursor/rules/testing-standards.mdcCursor rule
- llms-full.txtllms.txt
- llms.txtllms.txt
The file
We split this code-style.mdc into the rules it gives an agent
6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 8
Do not edit manually unless you plan to run reverse-sync.
- Distinctive: line 14
Write clean, modular, and self-documenting code.
- Distinctive: line 15
Always prefer strict types, immutable data structures, and pure functions where reasonable.
- Distinctive: line 16
Keep functions concise with a single responsibility.
- Distinctive: line 18
Avoid unnecessary dependencies.
- Distinctive: line 36
When a bug is fixed, add a test that fails without the change and name the regression in the test description.
≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
--- description: 'Enforce clean, readable, modern standards across the project' alwaysApply: true --- <!-- ⚠️ AUTO-GENERATED BY SYNCYTIUM-MD ⚠️ This file is automatically synchronized from .syncytium/ Do not edit manually unless you plan to run reverse-sync. Source of truth: .syncytium/ --> # Code Style & Formatting - Write clean, modular, and self-documenting code. - Always prefer strict types, immutable data structures, and pure functions where reasonable. - Keep functions concise with a single responsibility. - Preserve existing comments and documentation unless explicitly asked to modify them. - Avoid unnecessary dependencies; prefer standard library APIs where possible. ## Repository-specific conventions - **Comments explain *why*.** A comment restating what the code does is noise; a comment explaining a non-obvious constraint, a bug workaround, or a deliberate deviation is mandatory. Prefer a short comment at the point of the decision over a long block at the top of the file. - **Never let a shared, cached object escape.** `gray-matter` hands back the same object for identical content, and `DEFAULT_CONFIG` / `INITIAL_RULES` / `INITIAL_DECISIONS` are module-level singletons. Copy before mutating (see `clone()` in `src/core/storage.ts` and `deepClone()` in the config path). - **Order-dependent output is a bug.** Rule loading is sorted explicitly so generated files are byte-identical across platforms. - **Derive, do not duplicate.** The version lives in `src/version.ts`, the Markdown renderer in `src/ui/markdown.ts` (injected into the browser bundle via `Function.prototype.toString()`), and path safety in `src/core/paths.ts`. A second copy will drift. - When a bug is fixed, add a test that fails without the change and name the regression in the test description.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.