|
1 | | -# 🤖 Agentic Code Standards |
| 1 | +# 🤖 CodingWithAgent |
2 | 2 |
|
3 | | -**Production-ready coding standards and best practices for AI coding agents** |
| 3 | +**Production-ready coding standards and best practices for AI coding agents.** |
4 | 4 |
|
5 | | -Stop fighting with inconsistent AI code output. Get enterprise-grade standards that work across **all major AI coding tools** — Cursor, Windsurf, Google Antigravity, GitHub Copilot, Cline, and more. |
| 5 | +[](https://www.npmjs.com/package/codingwithagent) |
| 6 | +[](https://opensource.org/licenses/MIT) |
6 | 7 |
|
7 | | -## 🎯 What You Get |
| 8 | +Stop fighting with inconsistent AI code output. Get enterprise-grade standards that work across **all major AI coding tools**—Cursor, Windsurf, Google Antigravity, GitHub Copilot, and more. |
8 | 9 |
|
9 | | -- ♿ **Accessibility-First**: WCAG 2.1 AA+ compliance built-in |
10 | | -- ⚛️ **Modern Stack**: React, TypeScript, Node.js, Python best practices |
11 | | -- 🧪 **Testing Ready**: Unit, integration, E2E testing standards |
12 | | -- 🔒 **Security**: OpenSSF-aligned secure coding practices |
13 | | -- 📊 **Code Quality**: Maintainable, scalable patterns from day one |
14 | | -- 🌍 **Universal**: One standard, every AI coding agent |
| 10 | +Turn your AI assistant into a senior engineer that knows your team's rules. |
| 11 | + |
| 12 | +--- |
15 | 13 |
|
16 | 14 | ## 🚀 Quick Start |
17 | 15 |
|
18 | | -# Using npx (no installation needed!) |
| 16 | +Initialize standardized rules in your project with a single command. **No installation required.** |
19 | 17 |
|
20 | 18 | ```bash |
21 | 19 | npx codingwithagent init |
22 | 20 | ``` |
23 | 21 |
|
24 | | -# Or install globally |
| 22 | +The interactive CLI will guide you through the setup: |
25 | 23 |
|
26 | 24 | ``` |
27 | | -npm i -g codingwithagent |
28 | | -codingwithagent init |
| 25 | +🤖 CodingWithAgent |
| 26 | +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ |
| 27 | +Production-ready standards for AI coding agents |
| 28 | +
|
| 29 | +📋 Choose your profile: |
| 30 | +
|
| 31 | + 1. Minimal Essential rules only (great for getting started) |
| 32 | + 2. Standard Recommended baseline ⭐ (most popular) |
| 33 | + 3. Strict All rules enforced (maximum code quality) |
| 34 | + 4. Accessibility WCAG 2.1+ focused (a11y priority) |
| 35 | +
|
| 36 | +Enter number (1-4) [default: 2]: 2 |
| 37 | +
|
| 38 | +🛠️ Select your AI coding tool: |
| 39 | +
|
| 40 | + 1. Cursor (.cursorrules) |
| 41 | + 2. Windsurf (.windsurfrules) |
| 42 | + 3. Antigravity (.agent/rules/) |
| 43 | + 4. GitHub Copilot (.github/copilot-instructions.md) |
| 44 | + 5. Universal Works with most tools ⭐ |
| 45 | +
|
| 46 | +Enter number (1-5) [default: 5]: 1 |
| 47 | +
|
| 48 | +⚙️ Installing... |
| 49 | +
|
| 50 | +✨ Created .cursorrules with standard profile |
| 51 | +🎉 Setup complete! |
29 | 52 | ``` |
30 | 53 |
|
31 | | -## Choose your setup: |
| 54 | +## 📦 Profiles |
| 55 | + |
| 56 | +Choose the level of enforcement that fits your project maturity. |
| 57 | + |
| 58 | +| Profile | Description | Best For | |
| 59 | +| :------------------- | :---------------------------------------------------------------------------------------- | :------------------------------------------- | |
| 60 | +| **1. Minimal** | Essential rules only. Focuses on readability and basic modern patterns. | Prototyping, Hackathons, Personal Projects | |
| 61 | +| **2. Standard** ⭐ | **Recommended.** Balanced set of best practices for React, Testing, and Security. | Most Production Applications | |
| 62 | +| **3. Strict** | Maximum enforcement. TypeScript required, 90% test coverage, strict accessible standards. | Enterprise, Fintech, Healthcare, Large Teams | |
| 63 | +| **4. Accessibility** | Heavy focus on WCAG 2.1 AA compliance, accessible patterns, and ARIA usage. | Government, Public Sector, Inclusive Apps | |
| 64 | + |
| 65 | +## 🛠️ Supported Agents |
| 66 | + |
| 67 | +We standardize instructions across the entire AI ecosystem. |
| 68 | + |
| 69 | +### 1. Cursor (`.cursorrules`) |
| 70 | + |
| 71 | +Generates a comprehensive system prompt file in your project root. Cursor reads this to understand your tech stack, testing requirements, and styling preferences before it writes a single line of code. |
| 72 | + |
| 73 | +### 2. Windsurf (`.windsurfrules`) |
| 74 | + |
| 75 | +Creates a rule file compatible with the Windsurf editor, ensuring your Cascade flows follow your engineering standards. |
| 76 | + |
| 77 | +### 3. Google Antigravity (`.agent/rules/`) |
| 78 | + |
| 79 | +Installs a modular rule set in the `.agent` directory. Antigravity acts as a "Universal" agent and can ingest these specific markdown files (e.g., `accessibility.md`, `testing.md`) to contextually apply rules based on the user's task. |
| 80 | + |
| 81 | +### 4. GitHub Copilot (`.github/copilot-instructions.md`) |
| 82 | + |
| 83 | +Sets up project-specific instructions for GitHub Copilot Chat. This ensures Copilot suggests code that aligns with your specific architectural patterns. |
| 84 | + |
| 85 | +### 5. Universal |
| 86 | + |
| 87 | +A general-format rules file that works with most LLM-based tools that verify context files. |
| 88 | + |
| 89 | +## 🎯 What's Included? |
| 90 | + |
| 91 | +Depending on the profile, your rules will cover: |
| 92 | + |
| 93 | +- **⚡ Tech Stack**: React, TypeScript, Node.js, Next.js patterns. |
| 94 | +- **♿ Accessibility**: WCAG 2.1 AA+ compliance, correct ARIA usage, semantic HTML. |
| 95 | +- **🧪 Testing**: Unit (Jest/Vitest), Integration, and E2E testing standards. |
| 96 | +- **🔒 Security**: Input validation, output sanitization, secret management (OpenSSF aligned). |
| 97 | +- **🧠 Anti-Hallucinations**: Instructions to prevent AI from inventing libraries or APIs. |
| 98 | +- **📁 File Structure**: component/container architecture, proper folder organization. |
| 99 | + |
| 100 | +## 🤝 Contributing |
| 101 | + |
| 102 | +We welcome community contributions to improve these standards! |
| 103 | + |
| 104 | +1. Fork the repository. |
| 105 | +2. Add your improvements to the `templates` directory. |
| 106 | +3. Submit a Pull Request. |
| 107 | + |
| 108 | +See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidelines. |
| 109 | + |
| 110 | +## 📄 License |
32 | 111 |
|
33 | | -- Minimal (essential rules only) |
34 | | -- Standard (recommended baseline) ⭐ |
35 | | -- Strict (all rules enforced) |
36 | | -- Accessibility-focused |
37 | | -- Custom (pick and choose) |
| 112 | +This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details. |
0 commit comments