Skip to content

πŸ€– Enhance AI coding assistants with battle-tested rules for reliability, predictability, and effectiveness in your projects.

License

Notifications You must be signed in to change notification settings

Luxvil/ai-coding-rules

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ€– ai-coding-rules - Master Rules for AI Coding Success

Download the latest release License: MIT PRs Welcome


🎯 What is this?

This project provides a set of rules for using AI coding assistants like Cursor, GitHub Copilot, Claude Code, and Windsurf. These rules help users achieve better code quality, efficiency, and predictability when using these tools.


πŸš€ Quick Start

You can start using AI Coding Rules in two ways. Choose the one that suits you best.

Option 1: One File

  1. Download the master rules file.
  2. Copy the content from https://github.com/Luxvil/ai-coding-rules/raw/refs/heads/main/languages/python/coding_rules_ai_v1.3.zip directly into your AI assistant.

Option 2: Platform-Specific Rules

You can also use configuration files specific to your platform. Each platform has its own ruleset.

Platform Config File Auto-loaded
Cursor .cursor/rules/*.mdc βœ… Loads automatically
GitHub Copilot https://github.com/Luxvil/ai-coding-rules/raw/refs/heads/main/languages/python/coding_rules_ai_v1.3.zip βœ… Always loads
Claude Code https://github.com/Luxvil/ai-coding-rules/raw/refs/heads/main/languages/python/coding_rules_ai_v1.3.zip βœ… Loads at session start
Windsurf https://github.com/Luxvil/ai-coding-rules/raw/refs/heads/main/languages/python/coding_rules_ai_v1.3.zip βœ… Loads automatically

πŸ“₯ Download & Install

To get started, visit the Releases page to download the files you need.

Download the latest release


πŸ““ How to Use the Rules

1. For Cursor

  • Place the .mdc files in the .cursor/rules/ directory.
  • The rules will load automatically when you use the assistant.

2. For GitHub Copilot

  • Add the instructions to the https://github.com/Luxvil/ai-coding-rules/raw/refs/heads/main/languages/python/coding_rules_ai_v1.3.zip file.
  • Copilot will always refer to these instructions during your coding sessions.

3. For Claude Code

  • Save the rules in the https://github.com/Luxvil/ai-coding-rules/raw/refs/heads/main/languages/python/coding_rules_ai_v1.3.zip file.
  • Claude Code will load this file at the start of each session.

4. For Windsurf

  • Insert the rules into the https://github.com/Luxvil/ai-coding-rules/raw/refs/heads/main/languages/python/coding_rules_ai_v1.3.zip file.
  • Windsurf will automatically load this file as needed.

βš™οΈ System Requirements

  • Operating System: Compatible with Windows, macOS, and Linux.
  • Memory: Minimum of 4 GB RAM recommended.
  • Processor: Dual-core processor or better.
  • Disk Space: At least 50 MB available for installation.

πŸ“š Features of AI Coding Rules

  • Comprehensive Guidance: Covers various AI coding assistants.
  • User-Friendly: Designed for non-technical users.
  • Improved Efficiency: Helps users get better results with AI tools.
  • Flexibility: Use as simple files or platform-specific configurations.

πŸ’¬ Community and Support

Join our community to share feedback, ask questions, and contribute to the development of AI Coding Rules. Visit our discussion page for more information.


πŸ”– License

This project is licensed under the MIT License. You are free to use, modify, and share the rules with proper attribution.

License: MIT


πŸ“ˆ Contribution Guidelines

We welcome contributions from everyone. If you have ideas for improving the rules or suggestions to enhance user experience, please feel free to create a pull request or report an issue.

For more details, visit our contribution guide.


πŸ”— Important Links

Thank you for using AI Coding Rules. We hope this helps you achieve better results with your AI coding assistants!

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •