Skip to content

Commit ea3a6ca

Browse files
committed
feat: Introduce .cursorrules templates for various code standard profiles and an initialization script.
1 parent 343d223 commit ea3a6ca

7 files changed

Lines changed: 102 additions & 27 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to Agentic Code Standards
1+
# Contributing to CodingWithAgent
22

33
## Updating the Changelog
44

README.md

Lines changed: 95 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,112 @@
1-
# 🤖 Agentic Code Standards
1+
# 🤖 CodingWithAgent
22

3-
**Production-ready coding standards and best practices for AI coding agents**
3+
**Production-ready coding standards and best practices for AI coding agents.**
44

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+
[![npm version](https://img.shields.io/npm/v/codingwithagent.svg)](https://www.npmjs.com/package/codingwithagent)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
67

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.
89

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+
---
1513

1614
## 🚀 Quick Start
1715

18-
# Using npx (no installation needed!)
16+
Initialize standardized rules in your project with a single command. **No installation required.**
1917

2018
```bash
2119
npx codingwithagent init
2220
```
2321

24-
# Or install globally
22+
The interactive CLI will guide you through the setup:
2523

2624
```
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!
2952
```
3053

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
32111

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.

bin/init.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env node
22

33
/**
4-
* Agentic Code Standards CLI
4+
* CodingWithAgent CLI
55
* Interactive installer for AI coding agent standards
66
*/
77

@@ -31,7 +31,7 @@ function log(message, color = 'reset') {
3131

3232
function header() {
3333
console.log('');
34-
log('🤖 Agentic Code Standards', 'cyan');
34+
log('🤖 CodingWithAgent', 'cyan');
3535
log('━'.repeat(60), 'cyan');
3636
log('Production-ready standards for AI coding agents', 'bright');
3737
console.log('');

templates/accessibility/.cursorrules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Agentic Code Standards - Accessibility-Focused Profile
1+
# CodingWithAgent - Accessibility-Focused Profile
22

33
# Version: 1.0.0
44

templates/minimal/.cursorrules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Agentic Code Standards - Minimal Profile
1+
# CodingWithAgent - Minimal Profile
22

33
# Version: 1.0.0
44

templates/standard/.cursorrules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Agentic Code Standards - Standard Profile
1+
# CodingWithAgent - Standard Profile
22

33
# Version: 1.0.0
44

templates/strict/.cursorrules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Agentic Code Standards - Strict Profile
1+
# CodingWithAgent - Strict Profile
22

33
# Version: 1.0.0
44

0 commit comments

Comments
 (0)