Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
REVIEWER INSTRUCTIONS:
Please use the AI review command to conduct a thorough code review.
Run: ai/rules/review
Make sure to reference the JavaScript style guide: ai/rules/javascript/javascript.mdc
Run: ai/commands/review.md
Make sure to reference the JavaScript style guide: ai/skills/aidd-javascript/SKILL.md
This will help ensure code quality, best practices, and adherence to project standards.
-->
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ See the [Development Workflow](README.md#development-workflow) section in the RE

### JavaScript/TypeScript

- Follow the guidelines in `ai/rules/javascript/javascript.mdc`
- Follow the guidelines in `ai/skills/aidd-javascript/SKILL.md`
- Use functional programming patterns
- Keep functions small, pure, and composable
- Use `const`, avoid mutation
Expand Down Expand Up @@ -52,15 +52,15 @@ Types: `feat`, `fix`, `docs`, `test`, `refactor`, `chore`, `perf`, `ci`, `build`

1. Ensure all tests pass (`npm test`)
2. Update documentation if needed
3. Follow the code review guidelines in `ai/rules/review.mdc`
3. Follow the code review guidelines in `ai/skills/aidd-review/SKILL.md`
4. Address review feedback promptly
5. Squash commits if requested
6. Wait for approval from maintainers

## Questions or Issues?

- Check existing [issues](https://github.com/paralleldrive/aidd/issues)
- Review the AI rules in `ai/rules/` for guidance
- Review the AI skills in `ai/skills/` for guidance
- Ask questions in your PR or open a discussion

## License
Expand Down
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,17 +127,17 @@ npx aidd my-project
```bash
cd my-project
ls ai/ # See available components
cat ai/rules/please.mdc # Read the main orchestrator
cat ai/skills/aidd-please/SKILL.md # Read the main orchestrator
```

5. **Start using AI workflows**:
- Reference `ai/rules/` in AI prompts for better context
- Reference `ai/skills/` in AI prompts for better context
- Use `ai/commands/` as workflow templates
- Customize rules for your specific project needs
- Customize skills for your specific project needs

This gives you immediate access to:

- 🤖 **Agent orchestration rules** (`ai/rules/`)
- 🤖 **Agent orchestration skills** (`ai/skills/`)
- ⚙️ **AI workflow commands** (`ai/commands/`)
- 📋 **Development best practices** (JavaScript, TDD, UI/UX)
- 🎯 **Product management tools** (user stories, journey mapping)
Expand Down Expand Up @@ -430,13 +430,12 @@ your-project/
│ │ ├── review.md # Code reviews
│ │ ├── task.md # Task management
│ │ └── ...
│ ├── rules/ # Agent orchestration rules
│ │ ├── agent-orchestrator.mdc
│ │ ├── javascript/ # JS/TS best practices
│ │ ├── frameworks/ # Redux, TDD patterns
│ │ ├── productmanager.mdc
│ │ ├── tdd.mdc
│ │ ├── ui.mdc
│ ├── skills/ # Agent orchestration skills
│ │ ├── aidd-please/ # Main agent orchestrator
│ │ ├── aidd-javascript/ # JS/TS best practices
│ │ ├── aidd-tdd/ # Test-driven development
│ │ ├── aidd-review/ # Code review guidelines
│ │ ├── aidd-ui/ # UI/UX design guidelines
│ │ └── ...
│ └── ...
├── plan/ # Product discovery artifacts
Expand All @@ -448,13 +447,13 @@ your-project/

### Key Components

- **Agent Orchestrator** (`ai/rules/agent-orchestrator.mdc`) - Coordinates multiple AI agents
- **Development Rules** (`ai/rules/javascript/`, `ai/rules/tdd.mdc`) - Best practices and patterns
- **Agent Orchestrator** (`ai/skills/aidd-agent-orchestrator/SKILL.md`) - Coordinates multiple AI agents
- **Development Skills** (`ai/skills/aidd-javascript/`, `ai/skills/aidd-tdd/`) - Best practices and patterns
- **Workflow Commands** (`ai/commands/`) - Structured AI interaction templates
- **Product Management** (`ai/rules/productmanager.mdc`) - User stories and journey mapping
- **Product Management** (`ai/skills/aidd-product-manager/SKILL.md`) - User stories and journey mapping
- **Product Discovery Artifacts** (`plan/story-map/`) - User journeys, personas, and story maps (YAML format)
- **User Testing Scripts** (`plan/`) - Human and AI agent test scripts generated from journeys
- **UI/UX Guidelines** (`ai/rules/ui.mdc`) - Design and user experience standards
- **UI/UX Guidelines** (`ai/skills/aidd-ui/SKILL.md`) - Design and user experience standards

## 🎯 AI Integration

Expand Down Expand Up @@ -577,20 +576,20 @@ npx aidd my-project

**For Cursor users with existing rules:**

Reference the rules in your prompts or add to `.cursor/rules`:
Reference the skills in your prompts or add to `.cursor/skills`:

```
See ai/rules/javascript/javascript.mdc for JavaScript best practices
See ai/rules/tdd.mdc for test-driven development
See ai/rules/productmanager.mdc for product management
See ai/skills/aidd-javascript/SKILL.md for JavaScript best practices
See ai/skills/aidd-tdd/SKILL.md for test-driven development
See ai/skills/aidd-product-manager/SKILL.md for product management
```

**For other editors (VS Code, Vim, etc.):**

Reference rules directly in your AI assistant prompts:
Reference skills directly in your AI assistant prompts:

```
Please follow the guidelines in ai/rules/javascript/javascript.mdc
Please follow the guidelines in ai/skills/aidd-javascript/SKILL.md
Use the workflow from ai/commands/task.md
```

Expand All @@ -603,7 +602,7 @@ Use the workflow from ai/commands/task.md
ls ai/

# Verify key files exist
ls ai/rules/please.mdc
ls ai/skills/aidd-please/SKILL.md
ls ai/commands/
```

Expand Down
4 changes: 2 additions & 2 deletions ai/commands/discover.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## 🔍 Discover

Use productmanager.mdc to discover a user journey, user story, or feature.
Use [product manager](../skills/aidd-product-manager/SKILL.md) to discover a user journey, user story, or feature.

Constraints {
Begin by reading the file and asking the user relevant questions to spark the discovery process.
Before beginning, read and respect the constraints in please.mdc.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
}
2 changes: 1 addition & 1 deletion ai/commands/execute.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
Use the task creator to execute a task epic.

Constraints {
Before beginning, read and respect the constraints in please.mdc.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
Remember to use the TDD process if asked to implement code.
}
4 changes: 2 additions & 2 deletions ai/commands/help.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## ❓ Help

List commands from please.mdc and report them to the user.
List commands from [please](../skills/aidd-please/SKILL.md) and report them to the user.

Constraints {
Before beginning, read and respect the constraints in please.mdc.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
Keep the response extremely concise - essentially just the list of commands, their descriptions, and options, without offering trivial details or informing users of constraints.
}
4 changes: 2 additions & 2 deletions ai/commands/log.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 📝 Log

Use log.mdc to collect salient changes, and log them to the activity-log.md.
Before beginning, read and respect the constraints in please.mdc.
Use [log guide](../skills/aidd-log/SKILL.md) to collect salient changes, and log them to the activity-log.md.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
2 changes: 1 addition & 1 deletion ai/commands/plan.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 📋 Plan

Review plan.md to identify priorities and suggest next steps to the user -d 10.
Before beginning, read and respect the constraints in please.mdc.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
4 changes: 2 additions & 2 deletions ai/commands/review.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 🔬 Code Review

use review.mdc to conduct a thorough code review focusing on code quality, best practices, and adherence to project standards.
use [review guide](../skills/aidd-review/SKILL.md) to conduct a thorough code review focusing on code quality, best practices, and adherence to project standards.

Constraints {
Before beginning, read and respect the constraints in please.mdc.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
}
4 changes: 2 additions & 2 deletions ai/commands/run-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Execute AI agent test script in real browser.

Use @user-testing.mdc to run agent test, capturing screenshots and generating report.
Use [user testing](../skills/aidd-user-testing/SKILL.md) to run agent test, capturing screenshots and generating report.

Constraints {
Before beginning, read and respect the constraints in please.mdc.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
Drive real browser, narrate thoughts like human tester.
Generate structured markdown report with screenshots.
}
2 changes: 1 addition & 1 deletion ai/commands/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
Use the task creator to plan and execute a task epic.

Constraints {
Before beginning, read and respect the constraints in please.mdc.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
Remember to use the TDD process if asked to implement code.
}
4 changes: 2 additions & 2 deletions ai/commands/user-test.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## 🧪 User Test

Use @user-testing.mdc to generate human and AI agent test scripts from user journeys.
Use [user testing](../skills/aidd-user-testing/SKILL.md) to generate human and AI agent test scripts from user journeys.

Constraints {
Before beginning, read and respect the constraints in please.mdc.
Before beginning, read and respect the constraints in [please](../skills/aidd-please/SKILL.md).
}
4 changes: 4 additions & 0 deletions ai/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,7 @@ See [`commands/index.md`](./commands/index.md) for contents.

See [`rules/index.md`](./rules/index.md) for contents.

### 📁 skills/

See [`skills/index.md`](./skills/index.md) for contents.

15 changes: 1 addition & 14 deletions ai/rules/frameworks/redux/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,4 @@

This index provides an overview of the contents in this directory.

## Files

### Autodux

**File:** `autodux.mdc`

When building Redux state management, use this guide for creating and transpiling Autodux dux objects

### example

**File:** `example.mdc`

Autodux usage example showing Todo App implementation in SudoLang

*This directory is empty.*
70 changes: 0 additions & 70 deletions ai/rules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,79 +22,9 @@ See [`sudolang/index.md`](./sudolang/index.md) for contents.

## Files

### Aiden Agent Orchestrator

**File:** `agent-orchestrator.mdc`

Senior software engineer, product manager, project manager, and technical writer assistant with reflective thinking

**Always active**

### log

**File:** `log.mdc`

When documenting changes, use this guide for creating structured change logs with emoji categorization

### Aiden

**File:** `please.mdc`

When user says "please", use this guide for general assistance, logging, committing, and proofing tasks

**Always active**

### ProductManager

**File:** `productmanager.mdc`

When planning features, user stories, user journeys, or conducting product discovery, use this guide for building specifications and user journey maps

### Functional requirements

**File:** `requirements.mdc`

When writing functional requirements for a user story, use this guide for functional requirement specification

### 🔬 **COMPREHENSIVE CODE REVIEW: Release Latest Tag Epic**

**File:** `review-example.md`

*No description available*

### 🔬 Code Review

**File:** `review.mdc`

Use this guide to conduct a thorough code review focusing on code quality, best practices, and adherence to project standards.

### Tech Stack

**File:** `stack.mdc`

When implementing NextJS + React/Redux + Shadcn UI features, use this guide for tech stack guidance and best practices

### Task Creator

**File:** `task-creator.mdc`

when the user asks you to complete a task, use this guide for systematic task/epic planning and execution

### TDD Engineer

**File:** `tdd.mdc`

*No description available*

### UI/UX Engineer

**File:** `ui.mdc`

When building user interfaces and user experiences, use this guide for beautiful and friendly UI/UX design

### User Testing Generator

**File:** `user-testing.mdc`

Generate human and AI agent test scripts from user journey specifications

21 changes: 1 addition & 20 deletions ai/rules/javascript/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,4 @@

This index provides an overview of the contents in this directory.

## Files

### Error Causes Rule

**File:** `error-causes.mdc`

*No description available*

### JavaScript IO Guide

**File:** `javascript-io-network-effects.mdc`

When you need to make network requests or invoke side-effects, use this guide for saga pattern implementation

### JavaScript/TypeScript guide

**File:** `javascript.mdc`

*No description available*

*This directory is empty.*
8 changes: 4 additions & 4 deletions ai/rules/review-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ lib/

## **2. JavaScript Standards Compliance** ✅

### **Outstanding Adherence to javascript.mdc**
### **Outstanding Adherence to JavaScript Guidelines**

**Functional Programming Excellence:**

Expand Down Expand Up @@ -104,7 +104,7 @@ assert({

### **Clean Comment Implementation**

After our comment cleanup effort, all code follows javascript.mdc comment policy:
After our comment cleanup effort, all code follows JavaScript guidelines comment policy:

- **✅ No Style Guide Reiteration**: Removed all violations
- **✅ No Obvious Redundancy**: Clean, self-documenting code
Expand Down Expand Up @@ -249,10 +249,10 @@ This code is **production-ready** and represents **best-in-class** implementatio

## **Review Methodology**

This review was conducted following the review.mdc guidelines:
This review was conducted following the review skill guidelines:

1. ✅ **Code Structure Analysis**: Architecture and organization patterns
2. ✅ **Standards Compliance**: JavaScript.mdc and TDD.mdc adherence
2. ✅ **Standards Compliance**: JavaScript and TDD guidelines adherence
3. ✅ **Test Coverage Evaluation**: Quality and thoroughness of tests
4. ✅ **Performance & Security**: Efficiency and safety considerations
5. ✅ **Architecture Validation**: Design patterns and decisions
Expand Down
Loading