Skip to content

Bugfix Issues 82 and 84 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
harmjeff wants to merge 2 commits into from
Closed

Bugfix Issues 82 and 84 #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c38045
fix: correct GitHub Copilot setup instructions (#82)
harmjeff Feb 23, 2026
430e75f
fix: place rule details inside steering directory for Kiro CLI (#84)
harmjeff Feb 23, 2026
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
90 changes: 34 additions & 56 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,28 +165,30 @@ xcopy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-detai

AI-DLC uses [Kiro Steering Files](https://kiro.dev/docs/cli/steering/) to implement its intelligent workflow.

> **Note**: Kiro CLI resolves relative paths from the steering file location, so `.aidlc-rule-details/` must be placed inside the `aws-aidlc-rules/` directory alongside `core-workflow.md`.

**Unix/Linux/macOS:**
```bash
mkdir -p .kiro/steering
cp -R ../aidlc-workflows/aidlc-rules/aws-aidlc-rules .kiro/steering/
mkdir -p .aidlc-rule-details
cp -R ../aidlc-workflows/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/
mkdir -p .kiro/steering/aws-aidlc-rules/.aidlc-rule-details
cp -R ../aidlc-workflows/aidlc-rules/aws-aidlc-rule-details/* .kiro/steering/aws-aidlc-rules/.aidlc-rule-details/
```

**Windows PowerShell:**
```powershell
New-Item -ItemType Directory -Force -Path ".kiro\steering"
Copy-Item "..\aidlc-workflows\aidlc-rules\aws-aidlc-rules" ".kiro\steering\" -Recurse
New-Item -ItemType Directory -Force -Path ".aidlc-rule-details"
Copy-Item "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse
New-Item -ItemType Directory -Force -Path ".kiro\steering\aws-aidlc-rules\.aidlc-rule-details"
Copy-Item "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details\*" ".kiro\steering\aws-aidlc-rules\.aidlc-rule-details\" -Recurse
```

**Windows CMD:**
```cmd
mkdir .kiro\steering
xcopy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rules" ".kiro\steering\" /E /I
mkdir .aidlc-rule-details
xcopy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I
mkdir .kiro\steering\aws-aidlc-rules\.aidlc-rule-details
xcopy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details" ".kiro\steering\aws-aidlc-rules\.aidlc-rule-details\" /E /I
```

**Verify Setup:**
Expand All @@ -199,15 +201,15 @@ xcopy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-detai
**Directory Structure:**
```
<my-project>/
├── .kiro/
│ └── steering/
│ └── aws-aidlc-rules/
│ └── core-workflow.md
└── .aidlc-rule-details/
├── common/
├── inception/
├── construction/
└── operations/
└── .kiro/
└── steering/
└── aws-aidlc-rules/
├── core-workflow.md
└── .aidlc-rule-details/
├── common/
├── inception/
├── construction/
└── operations/
```

---
Expand Down Expand Up @@ -475,67 +477,43 @@ xcopy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-detai

### GitHub Copilot

AI-DLC uses project context files and Copilot's Chat capabilities to implement its intelligent workflow.

#### Option 1: .copilot Directory (Recommended)

**Unix/Linux/macOS:**
```bash
mkdir -p .copilot
cp ../aidlc-workflows/aidlc-rules/aws-aidlc-rules/core-workflow.md .copilot/instructions.md
mkdir -p .aidlc-rule-details
cp -R ../aidlc-workflows/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/
```

**Windows PowerShell:**
```powershell
New-Item -ItemType Directory -Force -Path ".copilot"
Copy-Item "..\aidlc-workflows\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".copilot\instructions.md"
New-Item -ItemType Directory -Force -Path ".aidlc-rule-details"
Copy-Item "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse
```

**Windows CMD:**
```cmd
mkdir .copilot
copy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".copilot\instructions.md"
mkdir .aidlc-rule-details
xcopy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I
```

#### Option 2: Project Root COPILOT.md
AI-DLC uses [GitHub Copilot custom instructions](https://code.visualstudio.com/docs/copilot/customization/custom-instructions) to implement its intelligent workflow. The `.github/copilot-instructions.md` file is automatically detected and applied to all chat requests in the workspace.

**Unix/Linux/macOS:**
```bash
cp ../aidlc-workflows/aidlc-rules/aws-aidlc-rules/core-workflow.md ./COPILOT.md
mkdir -p .github
cp ../aidlc-workflows/aidlc-rules/aws-aidlc-rules/core-workflow.md .github/copilot-instructions.md
mkdir -p .aidlc-rule-details
cp -R ../aidlc-workflows/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/
```

**Windows PowerShell:**
```powershell
Copy-Item "..\aidlc-workflows\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\COPILOT.md"
New-Item -ItemType Directory -Force -Path ".github"
Copy-Item "..\aidlc-workflows\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".github\copilot-instructions.md"
New-Item -ItemType Directory -Force -Path ".aidlc-rule-details"
Copy-Item "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse
```

**Windows CMD:**
```cmd
copy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\COPILOT.md"
mkdir .github
copy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".github\copilot-instructions.md"
mkdir .aidlc-rule-details
xcopy "..\aidlc-workflows\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I
```

**Verify Setup:**
1. Open VS Code with your project folder
2. Open the Copilot Chat panel (Cmd/Ctrl+Shift+I)
3. Reference the instructions by typing `#file .copilot/instructions.md` or `#file COPILOT.md` in the chat
3. Select **Configure Chat** (gear icon) > **Chat Instructions** and verify that `copilot-instructions` is listed
4. Alternatively, type `/instructions` in the chat input to view active instructions

**Directory Structure (Option 1):**
**Directory Structure:**
```
<my-project>/
├── .copilot/
│ └── instructions.md
├── .github/
│ └── copilot-instructions.md
└── .aidlc-rule-details/
├── common/
├── inception/
Expand Down Expand Up @@ -611,6 +589,7 @@ Deployment and monitoring (future)
#### Amazon Q Developer / Kiro CLI
- Use `/context show` to verify rules are loaded
- Check `.amazonq/rules/` or `.kiro/steering/` directory structure
- For Kiro CLI, ensure `.aidlc-rule-details/` is inside `.kiro/steering/aws-aidlc-rules/` (not the project root)

#### Cursor
- For "Apply Intelligently", ensure a description is defined in frontmatter
Expand All @@ -626,8 +605,9 @@ Deployment and monitoring (future)
- Ask "What instructions are currently active in this project?"

#### GitHub Copilot
- Use `#file <path>` syntax to reference instruction files
- For large instructions, reference specific rule detail files instead of pasting everything
- Select **Configure Chat** (gear icon) > **Chat Instructions** to verify instructions are loaded
- Type `/instructions` in the chat input to view active instruction files
- Check that `.github/copilot-instructions.md` exists in your workspace root

### File Path Issues on Windows
- Use forward slashes `/` in file paths within markdown files
Expand All @@ -641,21 +621,19 @@ Deployment and monitoring (future)
```gitignore
# These should be version controlled
CLAUDE.md
COPILOT.md
AGENTS.md
.amazonq/rules/
.kiro/steering/
.cursor/rules/
.clinerules/
.copilot/
.github/copilot-instructions.md
.aidlc-rule-details/
```

**Optional - Add to `.gitignore` (if needed):**
```gitignore
# Local-only settings
.claude/settings.local.json
.copilot/context/
```

---
Expand Down