No description
This commit introduces a comprehensive guide that outlines best practices for writing documents in Typst, covering various aspects such as document setup, structure, content organization, typography, and more to ensure high-quality documents. |
||
|---|---|---|
| common | ||
| go | ||
| meta | ||
| python | ||
| typst | ||
| README.md | ||
Cursor Rules Collection
A collection of custom rules for Cursor, the AI-powered code editor. These rules help customize AI behavior for specific programming languages and workflows.
What are Cursor Rules?
Cursor Rules are custom instructions for the AI assistant in Cursor, guiding its behavior when interpreting code, generating suggestions, and responding to queries. They can be:
- Global Rules: Set in Cursor Settings under
General>Rules for AI - Project-Specific Rules: Defined in the
.cursor/rulesdirectory in your project
Rules in this Repository
This repository contains rules for:
- Go: Best practices for Go development, including dependency management
- Python: Guidelines for using
uvfor Python project management - Common: General purpose rules that aren't language-specific
- Meta Rules: Rules for creating and improving Cursor rules themselves
How to Use These Rules
-
Global Usage:
- Copy the content of any
.mdcfile - Go to Cursor Settings > General > Rules for AI
- Paste the content into the text area
- Copy the content of any
-
Project-Specific Usage (Recommended: Symlink):
- Instead of copying files, create symbolic links to the rule files in this repository
- This allows you to automatically get updates when the repository is updated
- Create the
.cursor/rulesdirectory in your project if it doesn't exist - Symlink the desired
.mdcfiles:# Example for Unix/Linux/macOS ln -s /path/to/this/repo/go/go-mod-handling.mdc /path/to/your/project/.cursor/rules/ # Example for Windows (requires admin privileges) mklink /path/to/your/project/.cursor/rules/go-mod-handling.mdc /path/to/this/repo/go/go-mod-handling.mdc
-
Alternative: Manual Copy:
- Copy the content of any
.mdcfile - Create a file in the
.cursor/rulesdirectory of your project - Paste the content into this file
- You can use the command palette with
Cmd + Shift + P>New Cursor Rule
- Copy the content of any
Contributing
Feel free to contribute your own Cursor rules by submitting a pull request!
Resources
- Official Cursor Documentation on Rules for AI
- Cursor Directory - Community-curated collection of Cursor rules