https://github.com/hashiiiii/rules-for-ai
Rules and guidelines for optimizing AI coding assistant interactions in Windsurf and Cursor IDEs.
https://github.com/hashiiiii/rules-for-ai
ai ai-agents ai-assistant coding-agents coding-assistant cursor editor windsurf
Last synced: 4 months ago
JSON representation
Rules and guidelines for optimizing AI coding assistant interactions in Windsurf and Cursor IDEs.
- Host: GitHub
- URL: https://github.com/hashiiiii/rules-for-ai
- Owner: hashiiiii
- License: mit
- Created: 2025-02-26T16:27:23.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-26T16:42:46.000Z (4 months ago)
- Last Synced: 2025-02-26T17:38:22.637Z (4 months ago)
- Topics: ai, ai-agents, ai-assistant, coding-agents, coding-assistant, cursor, editor, windsurf
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🤖 Rules for AI
Documentation ([English](https://github.com/hashiiiii/rules-for-ai/blob/main/README.md), [日本語](https://github.com/hashiiiii/rules-for-ai/blob/main/README_JA.md))
## 📋 Overview
This is a ruleset to enhance AI assistants integrated in Windsurf and Cursor.
For global settings, use the predefined windsurf: global_rules.md / cursor: .cursorrules.
For workspace-specific settings, use windsurf: .windsurfrules / cursor: project_rules.mdc.
These are automatically updated through interactive dialogue with the AI assistant.
> [!WARNING]
>
> windsurf
> - global: global_rules.md
> - local: .windsurfrules
> - docs: https://docs.codeium.com/windsurf/memories#windsurfrules
>
> cursor
> - global: .cursorrules
> - local: project_rules.mdc
> - docs: https://docs.cursor.com/context/rules-for-ai
>
## ✨ Key Features
- 🔄 **Interactive Setup**: Interactively tune .windsurfrules / project_rules.mdc
- 📝 **High-Quality Common Configuration Files**: Pre-defined high-quality global_rules.md / .cursorrules
- ⚡ **Task-Oriented Shortcuts**: Shortcuts that can be used universally for each task
## 🚀 Quick Start
1. Clone the repository:
```bash
git clone https://github.com/hashiiiii/rules-for-ai.git
```
2. Open any workspace in your IDE and set up the rules files:
- `.windsurfrules` / `global_rules.md` - For Windsurf IDE
- `project_rules.mdc` / `.cursorrules` - For Cursor IDE
> [!IMPORTANT]
>
> If global settings are sufficient, migration steps are not necessary.
>
3. Run the setup command
- Execute the `/setup` command in write mode
4. Verify that .windsurfrules / project_rules.mdc has been updated
- If no updates occur, please ask the AI assistant to update in write mode
## 🔍 Available Shortcuts
- `/setup` : Start the setup process
- `/adjust` : Fine-tune the current workspace configuration file
- `/plan` : Create a detailed work plan
- `/debug` : Systematic debugging approach
- `/review` : Code quality review
- `/refactor`: Improve readability and maintainability
- `/optimize`: Performance optimization suggestions
- `/test` : Testing strategy
- `/doc` : Documentation assistance
- `/arch` : Architecture design
- `/cmt` : Code comments
- `/mvp` : Build an MVP (Minimum Viable Product)
- `/help` : Display available shortcuts
## 📄 License
This project is provided under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.