Skip to content

Commit dab8340

Browse files
committed
feat: Add README documentation for various code standard profiles and Antigravity tool templates.
1 parent bbfe93a commit dab8340

8 files changed

Lines changed: 338 additions & 0 deletions

File tree

templates/accessibility/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Accessibility Profile
2+
3+
WCAG 2.1+ focused development with accessibility as the top priority.
4+
5+
## What's Included
6+
7+
- Comprehensive WCAG 2.1 Level AA (minimum)
8+
- Screen reader testing required
9+
- Keyboard navigation mandatory
10+
- Color contrast enforcement
11+
- ARIA patterns and best practices
12+
13+
## Best For
14+
15+
- Government projects
16+
- Healthcare applications
17+
- Educational platforms
18+
- Projects with accessibility requirements
19+
20+
## Coverage
21+
22+
- POUR principles (Perceivable, Operable, Understandable, Robust)
23+
- Detailed ARIA implementation
24+
- Manual testing requirements
25+
- Automated accessibility testing
26+
- User testing with people with disabilities
27+
28+
## Quick Start
29+
30+
```bash
31+
npx agentic-code-standards init
32+
# Select: 4. Accessibility
33+
```
34+
35+
### What you get
36+
37+
A `.cursorrules` file focused on:
38+
39+
- WCAG 2.1 compliance
40+
- Screen reader compatibility
41+
- Keyboard accessibility
42+
- Color contrast requirements
43+
- Semantic HTML enforcement
44+
45+
## Philosophy
46+
47+
"The power of the Web is in its universality. Access by everyone regardless of disability is essential." - Tim Berners-Lee
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Antigravity - Accessibility Profile
2+
3+
Deep accessibility focus with WCAG 2.1+ priority.
4+
5+
## What's Included
6+
7+
3 comprehensive accessibility rule files:
8+
9+
- `accessibility.md` - POUR principles, testing requirements
10+
- `wcag-standards.md` - WCAG 2.1 Level A/AA reference
11+
- `aria-patterns.md` - Common ARIA patterns and best practices
12+
13+
## Installation
14+
15+
```bash
16+
npx agentic-code-standards init
17+
# Select tool: 3. Antigravity
18+
# Select profile: 4. Accessibility
19+
```
20+
21+
## Files created
22+
23+
```
24+
.agent/rules/
25+
├── accessibility.md
26+
├── wcag-standards.md
27+
└── aria-patterns.md
28+
```
29+
30+
## Testing Requirements
31+
32+
- Screen reader testing mandatory
33+
- Keyboard navigation required
34+
- Color contrast verification
35+
- Lighthouse accessibility: 100
36+
37+
## Best For
38+
39+
- Government projects
40+
- Healthcare applications
41+
- Educational platforms
42+
- WCAG compliance required
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Antigravity - Minimal Profile
2+
3+
Essential rules for Antigravity AI agent in modular format.
4+
5+
## What's Included
6+
7+
3 focused rule files:
8+
9+
- `accessibility.md` - Basic a11y requirements
10+
- `code-quality.md` - Essential patterns
11+
- `react-components.md` - Component basics
12+
13+
## Installation
14+
15+
```bash
16+
npx agentic-code-standards init
17+
# Select tool: 3. Antigravity
18+
# Select profile: 1. Minimal
19+
```
20+
21+
## Files created
22+
23+
```
24+
.agent/rules/
25+
├── accessibility.md
26+
├── code-quality.md
27+
└── react-components.md
28+
```
29+
30+
## Best for
31+
32+
- Getting started with Antigravity
33+
- Small projects
34+
- Learning the basics
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Antigravity - Standard Profile ⭐
2+
3+
Recommended baseline for production code with comprehensive rules.
4+
5+
## What's Included
6+
7+
5 detailed rule files:
8+
9+
- `accessibility.md` - WCAG 2.1 AA standards
10+
- `code-quality.md` - Naming, patterns, best practices
11+
- `react-components.md` - Hooks, JSX, component design
12+
- `testing.md` - 80%+ coverage, testing patterns
13+
- `pull-request-review.md` - PR standards and review checklist
14+
15+
## Installation
16+
17+
```bash
18+
npx agentic-code-standards init
19+
# Select tool: 3. Antigravity
20+
# Select profile: 2. Standard
21+
```
22+
23+
## Files created
24+
25+
```
26+
.agent/rules/
27+
├── accessibility.md
28+
├── code-quality.md
29+
├── react-components.md
30+
├── testing.md
31+
└── pull-request-review.md
32+
```
33+
34+
## Best For
35+
36+
- Production applications
37+
- Team projects
38+
- Enterprise development
39+
- Long-term maintenance
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Antigravity - Strict Profile
2+
3+
Maximum enforcement with zero tolerance for violations.
4+
5+
## What's Included
6+
7+
6 comprehensive rule files:
8+
9+
- `accessibility.md` - WCAG 2.1 AAA standards
10+
- `code-quality.md` - 90% coverage, TypeScript mandatory
11+
- `react-components.md` - 100% component coverage, strict hooks
12+
- `testing.md` - 90% minimum, zero flaky tests
13+
- `pull-request-review.md` - 2+ approvals, strict SLA
14+
- `security.md` - OWASP compliance, zero vulnerabilities
15+
16+
## Installation
17+
18+
```bash
19+
npx agentic-code-standards init
20+
# Select tool: 3. Antigravity
21+
# Select profile: 3. Strict
22+
```
23+
24+
## Files created
25+
26+
```
27+
.agent/rules/
28+
├── accessibility.md
29+
├── code-quality.md
30+
├── react-components.md
31+
├── testing.md
32+
├── pull-request-review.md
33+
└── security.md
34+
```
35+
36+
## Requirements
37+
38+
- TypeScript (no `any` type)
39+
- Components max 150 lines
40+
- Lighthouse accessibility: 100
41+
- Security vulnerabilities: 0
42+
- Performance score: >90
43+
44+
## Warning
45+
46+
Only use if committed to maximum quality.

templates/minimal/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Minimal Profile
2+
3+
Essential coding standards for getting started with AI agents.
4+
5+
## What's Included
6+
7+
- Basic accessibility requirements
8+
- Naming conventions
9+
- React component basics
10+
- Code quality essentials
11+
12+
## Best For
13+
14+
- Small projects
15+
- Getting started
16+
- Rapid prototyping
17+
- Personal projects
18+
19+
## Coverage
20+
21+
- Keyboard navigation
22+
- Alt text for images
23+
- Semantic HTML
24+
- Basic React patterns
25+
26+
## Quick Start
27+
28+
```bash
29+
npx agentic-code-standards init
30+
# Select: 1. Minimal
31+
```
32+
33+
### What you get
34+
35+
A `.cursorrules` file with the rules focusing on:
36+
37+
- Clean, readable code
38+
- Basic accessibility compliance
39+
- Modern JavaScript patterns
40+
- Simple React best practices

templates/standard/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Standard Profile ⭐
2+
3+
Recommended baseline for production applications. Most popular choice.
4+
5+
## What's Included
6+
7+
- WCAG 2.1 Level AA accessibility
8+
- Comprehensive React patterns
9+
- Testing standards (80%+ coverage)
10+
- Security best practices
11+
- Performance guidelines
12+
13+
## Best For
14+
15+
- Production applications
16+
- Team projects
17+
- Client work
18+
- Long-term maintenance
19+
20+
## Coverage
21+
22+
- Full keyboard accessibility
23+
- Screen reader compatibility
24+
- Component best practices
25+
- Testing requirements
26+
- Pull request standards
27+
28+
## Quick Start
29+
30+
```bash
31+
npx agentic-code-standards init
32+
# Select: 2. Standard
33+
```
34+
35+
### What you get
36+
37+
A `.cursorrules` file with the rules focusing on:
38+
39+
- Accessibility (WCAG 2.1 AA)
40+
- React & TypeScript
41+
- Testing & coverage
42+
- Security & PII
43+
- Code quality & performance

templates/strict/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Strict Profile
2+
3+
Maximum code quality enforcement. All rules strictly applied.
4+
5+
## What's Included
6+
7+
- WCAG 2.1 AAA accessibility (when possible)
8+
- TypeScript mandatory (no `any` type)
9+
- 90% test coverage minimum
10+
- Zero security vulnerabilities
11+
- Maximum component size: 150 lines
12+
13+
## Best For
14+
15+
- Enterprise applications
16+
- High-security projects
17+
- Mission-critical systems
18+
- Teams committed to excellence
19+
20+
## Coverage
21+
22+
- 100% accessibility compliance
23+
- Strict TypeScript enforcement
24+
- Mandatory code reviews (2+ approvals)
25+
- Security-first development
26+
- Performance budgets enforced
27+
28+
## Quick Start
29+
30+
```bash
31+
npx agentic-code-standards init
32+
# Select: 3. Strict
33+
```
34+
35+
### What you get
36+
37+
A `.cursorrules` file with strict enforcement of:
38+
39+
- Zero tolerance for violations
40+
- Automated PR rejection for issues
41+
- Lighthouse accessibility: 100
42+
- Performance score: >90
43+
- Security vulnerabilities: 0
44+
45+
## Warning
46+
47+
Only use if your team is committed to maximum quality standards.

0 commit comments

Comments
 (0)