https://github.com/salahu01/ide-agent-rules
🤖 Comprehensive coding standards and best practices for AI-powered IDEs and coding assistants
https://github.com/salahu01/ide-agent-rules
ai ai-agents aicoding best-practices cursor cursorrules dart flutter trae
Last synced: 4 months ago
JSON representation
🤖 Comprehensive coding standards and best practices for AI-powered IDEs and coding assistants
- Host: GitHub
- URL: https://github.com/salahu01/ide-agent-rules
- Owner: salahu01
- License: mit
- Created: 2025-09-04T17:01:36.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-09-04T17:15:00.000Z (5 months ago)
- Last Synced: 2025-09-29T12:43:48.096Z (4 months ago)
- Topics: ai, ai-agents, aicoding, best-practices, cursor, cursorrules, dart, flutter, trae
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IDE Agent Rules Repository
> **Empowering AI coding assistants with comprehensive guidelines for better, cleaner, and more readable code**
[](https://opensource.org/licenses/MIT)
[](https://github.com/yourusername/IDE-Agent-Rules/graphs/commit-activity)
[](http://makeapullrequest.com)
[](CONTRIBUTING.md)
[](https://flutter.dev)
[](https://dart.dev)
## 🎯 Purpose
This repository contains curated rules and guidelines designed to help IDE agents (like Cursor, TRAE, etc.) generate higher quality, more maintainable code. These rules are based on established software engineering principles and best practices, adapted for modern development workflows.
## 🏗️ Repository Structure
```
IDE-Agent-Rules/
├── README.md # This file - repository overview
├── 1_clean_code/ # Clean code principles and guidelines
│ ├── README.md # Comprehensive clean code guide
│ └── clean_code.md # Cursor-specific clean code rules for Dart/Flutter
└── [Future sections coming soon...]
```
## 📚 Current Content
### 1. Clean Code Principles (`1_clean_code/`)
**What it contains:**
- Comprehensive clean code guidelines based on Robert C. Martin's "Clean Code"
- Language-specific examples for Dart and Flutter
- Practical implementation strategies
- Code smell identification and resolution
- Team adoption guidelines
**Key topics covered:**
- Meaningful naming conventions
- Function design principles
- Class organization and responsibility
- Error handling best practices
- Testing guidelines
- Code formatting standards
**Target audience:**
- Flutter/Dart developers
- Teams adopting clean code practices
- AI coding assistants
- Code reviewers and maintainers
## 🚀 How to Use
### For Developers
1. **Read the guides** - Start with the clean code principles
2. **Apply the rules** - Use these guidelines in your daily coding
3. **Share with your team** - Help establish coding standards
4. **Contribute improvements** - Add your own insights and examples
### For IDE Agents
1. **Reference these rules** when generating code
2. **Apply clean code principles** automatically
3. **Suggest improvements** based on established guidelines
4. **Maintain consistency** across codebases
### For Teams
1. **Establish coding standards** based on these guidelines
2. **Use in code reviews** as a reference
3. **Train new team members** with these principles
4. **Improve code quality** systematically
## 🔮 Coming Soon
This repository is actively growing! Future sections will include:
- **Architecture Patterns** - Clean architecture, SOLID principles
- **Testing Strategies** - TDD, BDD, testing best practices
- **Performance Guidelines** - Optimization and efficiency rules
- **Security Best Practices** - Secure coding guidelines
- **Documentation Standards** - Code documentation and API docs
- **Team Collaboration** - Git workflows, code review processes
## 🤝 Contributing
We welcome contributions to improve these guidelines:
1. **Add new rules** - Share your coding wisdom
2. **Improve examples** - Make guidelines more practical
3. **Fix errors** - Help maintain accuracy
4. **Suggest new sections** - Expand the repository scope
### Contribution Guidelines
- Keep rules practical and actionable
- Provide clear examples
- Include language-specific adaptations
- Maintain consistent formatting
- Test rules with real code scenarios
## 📖 Resources
These guidelines are based on:
- **"Clean Code"** by Robert C. Martin (Uncle Bob)
- **Industry best practices** from leading tech companies
- **Real-world experience** from professional developers
- **Modern development tools** and frameworks
## 🎯 Goals
1. **Improve Code Quality** - Help developers write better code
2. **Standardize Practices** - Establish consistent coding standards
3. **Empower AI Assistants** - Give IDE agents better guidance
4. **Reduce Technical Debt** - Prevent code quality issues
5. **Foster Learning** - Share knowledge and best practices
## 📞 Support
- **Issues**: Report problems or suggest improvements
- **Discussions**: Share ideas and ask questions
- **Pull Requests**: Submit improvements and new content
## 📄 License
This repository is open source and available under the [MIT License](LICENSE).
---
**Start writing cleaner, more maintainable code today!** 🚀
_Remember: Clean code is not about perfection—it's about continuous improvement and professional craftsmanship._