Skip to content

Commit 27298ed

Browse files
committed
feat: initial commit
0 parents  commit 27298ed

File tree

6 files changed

+390
-0
lines changed

6 files changed

+390
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.DS_store
2+
.idea/

.trae/rules/project_rules.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Interactive Coding Agent Rules
2+
3+
🚨 **MANDATORY: YOU MUST IMMEDIATELY OPEN AND READ THE COMPLETE RULES** 🚨
4+
5+
**BEFORE ANY CODING SESSION, YOU ARE REQUIRED TO:**
6+
7+
1. **OPEN****[agents/index.md](../../agents/index.md)**
8+
2. **READ** → All mandatory standards and core principles
9+
3. **IMPLEMENT** → Every rule and compliance checklist
10+
11+
**FAILURE TO FOLLOW THESE RULES = CRITICAL VIOLATION**
12+
13+
This file contains:
14+
- ⚠️ **MANDATORY** stop points and question triggers
15+
- 🛑 **REQUIRED** interactive command usage
16+
-**ESSENTIAL** compliance checklists
17+
- 🚨 **CRITICAL** violation protocols
18+
19+
**NO EXCEPTIONS. NO ASSUMPTIONS. FOLLOW THE RULES.**
20+
21+
---
22+
23+
*Single source of truth for maintainability - MUST be followed by all agents.*
24+
25+
---
26+
27+
*Created by [@matscode](https://www.tiktok.com/@matscode) | [LinkedIn](https://www.linkedin.com/in/matscode)*

.windsurf/rules/project_rules.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
trigger: always_on
3+
---
4+
5+
# Interactive Coding Agent Rules
6+
7+
🚨 **MANDATORY: YOU MUST IMMEDIATELY OPEN AND READ THE COMPLETE RULES** 🚨
8+
9+
**BEFORE ANY CODING SESSION, YOU ARE REQUIRED TO:**
10+
11+
1. **OPEN****[agents/index.md](../agents/index.md)**
12+
2. **READ** → All mandatory standards and core principles
13+
3. **IMPLEMENT** → Every rule and compliance checklist
14+
15+
**FAILURE TO FOLLOW THESE RULES = CRITICAL VIOLATION**
16+
17+
This file contains:
18+
- ⚠️ **MANDATORY** stop points and question triggers
19+
- 🛑 **REQUIRED** interactive command usage
20+
-**ESSENTIAL** compliance checklists
21+
- 🚨 **CRITICAL** violation protocols
22+
23+
**NO EXCEPTIONS. NO ASSUMPTIONS. FOLLOW THE RULES.**
24+
25+
---
26+
27+
*Single source of truth for maintainability - MUST be followed by all agents.*
28+
29+
---
30+
31+
*Created by [@matscode](https://www.tiktok.com/@matscode) | [LinkedIn](https://www.linkedin.com/in/matscode)*

AGENTS.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Interactive Coding Agent Rules
2+
3+
🚨 **MANDATORY: YOU MUST IMMEDIATELY OPEN AND READ THE COMPLETE RULES** 🚨
4+
5+
**BEFORE ANY CODING SESSION, YOU ARE REQUIRED TO:**
6+
7+
1. **OPEN****[agents/index.md](./agents/index.md)**
8+
2. **READ** → All mandatory standards and core principles
9+
3. **IMPLEMENT** → Every rule and compliance checklist
10+
11+
**FAILURE TO FOLLOW THESE RULES = CRITICAL VIOLATION**
12+
13+
## Complete Interactive Rules
14+
15+
@./agents/index.md
16+
17+
## Key Requirements
18+
19+
This file contains:
20+
- ⚠️ **MANDATORY** stop points and question triggers
21+
- 🛑 **REQUIRED** interactive command usage
22+
-**ESSENTIAL** compliance checklists
23+
- 🚨 **CRITICAL** violation protocols
24+
25+
**NO EXCEPTIONS. NO ASSUMPTIONS. FOLLOW THE RULES.**
26+
27+
---
28+
29+
*Single source of truth for maintainability - MUST be followed by all agents.*
30+
31+
---
32+
33+
*Created by [@matscode](https://www.tiktok.com/@matscode) | [LinkedIn](https://www.linkedin.com/in/matscode)*

README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Interactive Coding Agent Project
2+
3+
A framework for implementing interactive coding assistants that ask clarifying questions instead of making assumptions, designed for senior engineers who value collaborative decision-making.
4+
5+
## 🎥 See It In Action
6+
7+
Watch how the Interactive Coding Agent works:
8+
- **TikTok**: [Interactive Coding Demo](https://www.tiktok.com/@matscode/video/7548933674947857671?is_from_webapp=1&sender_device=pc&web_id=7517615038972544518)
9+
- **YouTube**: [Interactive Coding Demo](https://www.youtube.com/shorts/dDPBXYnJjB4)
10+
11+
## Purpose
12+
13+
This project provides tested rules for creating coding agents that:
14+
- Stop and ask questions when requirements are vague
15+
- Confirm understanding before implementation
16+
- Verify feature scope matches user intent
17+
- Request explicit approval at each step
18+
- Always end sessions with user confirmation
19+
20+
## Benefits
21+
22+
- **Reduced Assumptions**: Agents ask instead of guessing
23+
- **Scope Control**: Prevents feature creep and unwanted additions
24+
- **Quality Assurance**: Built-in verification at every step
25+
- **Senior Engineer Friendly**: Respects expertise and decision-making
26+
- **Collaborative**: Promotes dialogue over silent implementation
27+
- **Prevents Violations**: Stops scope creep, unrequested features, and silent assumptions
28+
29+
## Setup
30+
31+
### Option 1: TRAE Custom Agent (Fastest & Recommended)
32+
33+
**Requirements:** [TRAE IDE](https://trae.ai) (download if needed)
34+
35+
1. Click the [one-click setup link](https://s.trae.ai/a/ff8cff)
36+
2. The agent will be automatically configured and ready to use
37+
38+
### Option 2: Full Setup (Second Recommended)
39+
**Copy and paste everything** from this folder into your project root. This gives you interactive coding agent capability in all configured editors.
40+
41+
### Option 3: Editor-Specific Setup
42+
If you only want to setup for one editor, copy these files:
43+
44+
**Always Required:**
45+
- `AGENTS.md` (root level)
46+
- `agents/` folder (contains the main rules)
47+
48+
**Plus your editor's config:**
49+
- For **Trae AI**: Copy `.trae/` folder
50+
- For **Cursor**: Copy `.cursor/` folder (if available)
51+
- For **Windsurf**: Copy `.windsurf/` folder
52+
53+
### How It Works
54+
Once copied, the rules will automatically apply when you start coding sessions in supported editors.
55+
56+
**Important:** After copying the configuration files, you must **start a new chat session** for the rules to take effect.
57+
58+
## Supported Agents
59+
60+
| Platform | Type | Status |
61+
|----------|------|--------|
62+
| **TRAE Custom Agent** | Custom |**Recommended** - [One-click setup](https://s.trae.ai/a/ff8cff) |
63+
| **Trae AI** | IDE | ✅ Tested |
64+
| **Cursor** | IDE | ✅ Tested |
65+
| **Windsurf** | IDE | ✅ Tested |
66+
| **Codex** | IDE | ⏳ Not Tested Yet |
67+
| **Claude Code** | IDE | ⏳ Not Tested Yet |
68+
| **Gemini** | CLI | ❌ Not Working Yet |
69+
| **Gemini Code Assist (VS Code)** | IDE | ❌ Not Working Yet |
70+
71+
---
72+
73+
*Created by [@matscode](https://www.tiktok.com/@matscode) | [LinkedIn](https://www.linkedin.com/in/matscode)*

0 commit comments

Comments
 (0)