{"id":28275324,"url":"https://github.com/walkingriver/ai-rules","last_synced_at":"2026-01-25T13:01:24.149Z","repository":{"id":293892818,"uuid":"985434303","full_name":"walkingriver/ai-rules","owner":"walkingriver","description":"A simple repo to compare and share various AI rules files","archived":false,"fork":false,"pushed_at":"2025-05-17T19:26:38.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-16T12:52:43.190Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/walkingriver.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-17T18:51:59.000Z","updated_at":"2025-05-17T19:26:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"88e2f7f6-65a8-46aa-b095-c9090ff21e43","html_url":"https://github.com/walkingriver/ai-rules","commit_stats":null,"previous_names":["walkingriver/ai-rules"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/walkingriver/ai-rules","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walkingriver%2Fai-rules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walkingriver%2Fai-rules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walkingriver%2Fai-rules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walkingriver%2Fai-rules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/walkingriver","download_url":"https://codeload.github.com/walkingriver/ai-rules/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/walkingriver%2Fai-rules/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28753411,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T10:25:12.305Z","status":"ssl_error","status_checked_at":"2026-01-25T10:25:11.933Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-21T03:13:56.490Z","updated_at":"2026-01-25T13:01:24.143Z","avatar_url":"https://github.com/walkingriver.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# AI Rules \n\nWelcome to the **AI Rules**, a community-driven repository for sharing and\nrefining configuration files that guide AI coding assistants like GitHub\nCopilot, Windsurf, and others.\n\nOur goal is to create a centralized collection of high-quality, reusable rules\nfiles—such as `.windsurfrules` and `.github/copilot-instructions.md`—that help\ndevelopers customize AI tools to align with their coding standards, project\nrequirements, and team workflows.\n\nWhether you're a solo developer tweaking your AI assistant or a team looking to\nstandardize AI-generated code, this repo is your go-to resource for discovering,\nsharing, and improving AI rules files.\n\n## Quick Start\n\nWant to grab a rules file and get coding? Follow these steps:\n\n### Browse and Use Rules Files\n\n1. **Browse Files:** Explore the repository to find rules files such as\n   `.windsurfrules` (for Windsurf) or `.github/copilot-instructions.md` (for\n   GitHub Copilot).\n\n2. **Download a File:**\n\n   - Click on the file you want.\n   - Use the \"Raw\" button to view the plain text.\n   - Copy the content or download the file directly to your project.\n\n3. **Add to Your Project:**\n\n   - For `.windsurfrules`, place it in your project’s root directory (or as\n     specified by Windsurf).\n   - For `.github/copilot-instructions.md`, place it in the `.github/` folder of\n     your repository.\n   - Adjust the file to match your coding style or project needs if necessary.\n\n4. **Test It Out:** Open your IDE with the AI tool enabled (e.g., GitHub Copilot\n   in VS Code) and see how the rules guide the AI’s suggestions.\n\n5. **Contribute Back:** Found a great file or made improvements? Please\n   [contribute back to the repo](#how-to-contribute)!\n\n---\n\n## Why This Repo?\n\nAI coding assistants are powerful, but they shine brightest when guided by\nclear, project-specific instructions. Rules files like `.windsurfrules` (for\nWindsurf) and `.github/copilot-instructions.md` (for GitHub Copilot) let you\ndefine coding styles, preferred tools, and best practices, ensuring AI outputs\nare consistent and relevant.\n\nHowever, crafting these files can be time-consuming, and finding good examples\nis often a challenge.\n\n**That’s where AI Rules Hub comes in! We aim to:**\n\n- Collect well-crafted rules files for various AI tools, languages, and\n  frameworks.\n- Share best practices to help developers get the most out of their AI\n  assistants.\n- Collaborate with the community to refine and expand our collection.\n\n---\n\n## What’s in the Repo?\n\nCurrently, the repo includes:\n\n- **.windsurfrules**: Configuration files for Windsurf, defining how the AI\n  should generate or review code.\n- **.github/copilot-instructions.md**: Custom instructions for GitHub Copilot,\n  tailoring its suggestions to specific coding standards or project needs.\n\n### File Structure\n\nHere is how we envision structuring the repo.\n\n```\nai-rules-hub/\n├── copilot/                            # GitHub Copilot rules files\n│   ├── angular-copilot-instructions.md\n│   ├── react-copilot-instructions.md   # Still needed\n│   └── node-copilot-instructions.md    # Still needed\n│   └── your-contribution\n├── windsurf/                           # Windsurf rules files\n│   ├── angular.windsurfrules\n│   └── react.windsurfrules             # Still needed\n│   └── your-contribution\n└── README.md                           # You’re reading it!\n```\n\n---\n\n## How to Contribute\n\nWe’re thrilled to have you contribute to AI Rules Hub! Whether you’re adding a\nnew rules file, improving an existing one, or suggesting better documentation,\nyour input is valuable.\n\n### Contribution Steps\n\n1. **Fork the Repository:**\n\n   - Click the \"Fork\" button at the top-right of this page to create a copy of\n     the repo under your GitHub account.\n\n2. **Clone Your Fork:**\n\n   ```bash\n   git clone https://github.com/walkingriver/ai-rules.git\n   cd ai-rules\n   ```\n\n3. **Create a Branch:**\n\n   ```bash\n   git checkout -b your-branch-name\n   ```\n\n4. **Add or Update Files:**\n\n   - Add your rules file (e.g., `.windsurfrules`,\n     `.github/copilot-instructions.md`) to the repo.\n   - Update the `README.md` or other documentation if needed.\n\n5. **Commit Your Changes:**\n\n   ```bash\n   git add .\n   git commit -m \"Add .windsurfrules for Python Flask projects\"\n   ```\n\n6. **Push to Your Fork:**\n\n   ```bash\n   git push origin your-branch-name\n   ```\n\n7. **Submit a Pull Request (PR):**\n\n   - Go to the original repo and click \"New Pull Request.\"\n   - Select your branch and provide a detailed description of your changes.\n   - Link any relevant issues (e.g., `Closes #123`) if applicable.\n   - Submit the PR and wait for feedback from maintainers.\n\n8. **Respond to Feedback:**\n   - We’ll review your PR and may suggest changes. Update your branch as needed\n     and push new commits.\n\n---\n\n## Contribution Guidelines\n\nTo keep the repo organized and high-quality, please follow these guidelines:\n\n- **File Naming:** Use descriptive names for rules files (e.g.,\n  `python-flask.windsurfrules` or `react-copilot-instructions.md`).\n- **Documentation:** Include a brief comment or section in your rules file\n  explaining its purpose, target AI tool, and any specific context (e.g.,\n  language, framework).\n- **Formatting:** For Markdown files like `.github/copilot-instructions.md`, use\n  clear, concise Markdown. For other formats, follow the AI tool’s conventions.\n- **No Sensitive Data:** Ensure rules files don’t contain sensitive information\n  (e.g., API keys, passwords).\n- **Test Your Rules:** If possible, test your rules file with the target AI tool\n  to confirm it works as intended. interactions.\n\n---\n\n## Ideas for Contributions\n\nNot sure where to start? Here are some ideas:\n\n- Share a `.windsurfrules` file tailored to a specific language (e.g., Go, Rust)\n  or framework (e.g., Django, Spring).\n- Add a `.github/copilot-instructions.md` for a niche use case, like embedded\n  systems or data science.\n- Create rules files for other AI tools (e.g., Cursor, Tabnine).\n- Write example prompts in `docs/examples.md` showing how to use rules files\n  effectively.\n- Improve this README with clearer instructions or a FAQ section.\n\n---\n\n## Security Note\n\nRules files can influence AI behavior, so we take security seriously. Malicious\nrules files could introduce vulnerabilities (e.g., via hidden Unicode\ncharacters). To protect our community:\n\n- We scan PRs for suspicious content.\n- We encourage contributors to review their rules files for unintended effects.\n- If you spot a security issue, report it privately via GitHub Security.\n\n---\n\n## Why Contribute?\n\nBy contributing to AI Rules Hub, you:\n\n- Help developers worldwide improve their AI-assisted coding workflows.\n- Showcase your expertise in AI tools and coding standards.\n- Build a collaborative community around AI-driven development.\n- Get your work featured in a growing, open-source project!\n\n---\n\n## Get in Touch\n\nHave questions or ideas? Reach out:\n\n- **Issues:** Report bugs or suggest features via GitHub Issues.\n- **Discussions:** Share ideas or ask questions in GitHub Discussions.\n- **X:** Follow me on X at [@WalkingRiver](https://x.com/walkingriver) for\n  updates and community highlights.\n\n---\n\n## License\n\nThis project is licensed under the MIT License (`LICENSE`). Feel free to use,\nmodify, and share the rules files, but please give credit to the contributors.\n\n---\n\n## Acknowledgments\n\nA huge thank you to all contributors who make AI Rules Hub possible! Special\nshoutout to the open-source community for inspiring this project and to tools\nlike GitHub Copilot and Windsurf for pushing the boundaries of AI-assisted\ncoding.\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwalkingriver%2Fai-rules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwalkingriver%2Fai-rules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwalkingriver%2Fai-rules/lists"}