docs(openhands): add keyword-triggered AI-DLC setup#372
Open
rajshah4 wants to merge 5 commits into
Open
Conversation
github-actions
Bot
added
the
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the README to document OpenHands support for AI-DLC, including setup steps, troubleshooting, and recommended repo hygiene.
Changes:
- Added an OpenHands section with two activation options (keyword-triggered skill vs. AGENTS.md fallback)
- Expanded troubleshooting with OpenHands-specific checks
- Updated
.gitignoreguidance and clarified a troubleshooting row
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1003
to
+1006
| # For OpenHands: commit the keyword-triggered skill; gitignore .aidlc/ | ||
| .agents/skills/ | ||
|
|
||
| # For OpenHands AGENTS.md fallback: commit AGENTS.md as a lightweight trigger |
Comment on lines
+948
to
+951
| | Rules not loading | Check file exists in the correct location for your platform | | ||
| | File encoding issues | Ensure files are UTF-8 encoded | | ||
| | Rules not applied in session | Start a new chat session after file changes | | ||
| | Rule details not loading | Verify `.aidlc-rule-details/` exists with subdirectories | | ||
| | Rule details not loading | Verify rule details directory exists with subdirectories | |
Author
|
Addressed Copilot's comments in |
rajshah4
requested review from
a team,
Kalindi-Dev,
Copilot,
harmjeff,
leandrodamascena,
raj-jain-aws,
scottschreckengaust and
spraja08
Comment on lines
+631
to
+645
| @' | ||
| --- | ||
| name: ai-dlc | ||
| description: Run the AI-DLC workflow for structured software development tasks. | ||
| triggers: | ||
| - AI-DLC | ||
| - AIDLC | ||
| --- | ||
|
|
||
| When the user invokes AI-DLC (starts with "Using AI-DLC, ..."), | ||
| read and follow `.aidlc/aidlc-rules/aws-aidlc-rules/core-workflow.md`. | ||
| '@ | Set-Content ".agents\skills\ai-dlc\SKILL.md" | ||
|
|
||
| # 4. Gitignore the rules directory (optional - commit it instead if you want rules pinned) | ||
| Add-Content ".gitignore" ".aidlc/" |
|
|
||
| When the user invokes AI-DLC (starts with "Using AI-DLC, ..."), | ||
| read and follow `.aidlc/aidlc-rules/aws-aidlc-rules/core-workflow.md`. | ||
| '@ | Add-Content ".\AGENTS.md" |
Comment on lines
1000
to
1008
| # These should be version controlled | ||
| CLAUDE.md | ||
|
|
||
| # For OpenHands: commit the keyword-triggered AI-DLC skill; gitignore .aidlc/ | ||
| .agents/skills/ai-dlc/ | ||
|
|
||
| # For OpenHands AGENTS.md fallback: commit AGENTS.md as a lightweight trigger | ||
| # For OpenAI Codex: commit AGENTS.md containing the full core-workflow.md content | ||
| AGENTS.md |
Author
|
Addressed the latest Copilot comments in |
| | Rules not loading | Check file exists in the correct location for your platform | | ||
| | File encoding issues | Ensure files are UTF-8 encoded | | ||
| | Rules not applied in session | Start a new chat session after file changes | | ||
| | Rule details not loading | Verify the platform-specific rule details path, e.g. `.aidlc/aidlc-rules/aws-aidlc-rule-details/` exists | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds OpenHands as a named AI-DLC setup path, but frames it around OpenHands' loading model rather than platform branding.
OpenHands supports always-on repository context through
AGENTS.md, but also supports keyword-triggered skills. Since AI-DLC is meant to activate when the user explicitly starts with "Using AI-DLC, ...", the recommended OpenHands setup now uses a small keyword-triggered skill that points to the full rules under.aidlc/.Changes
.agents/skills/ai-dlc/SKILL.mdkeyword-triggered skill setup,.aidlc/rule storage,AGENTS.mdfallback for users who prefer that convention,.aidlc/unless users want pinned rule copies,AGENTS.mdfallback from the OpenAI Codex full-AGENTS.mdsetup..aidlc/rule details path.User experience
Before: OpenHands users were not named in the setup guide. They could reasonably follow the OpenAI Codex
AGENTS.mdpath and copy the full AI-DLC workflow into always-on repository context, even when the current task was not an AI-DLC workflow.After: OpenHands users get a first-class setup that keeps
AGENTS.mdavailable for concise repository knowledge and loads AI-DLC through an explicit keyword-triggered skill only when the user invokes AI-DLC.Checklist
If your change doesn't seem to apply, please leave them unchecked.
Test Plan
core-workflow.mdalready checks.aidlc/aidlc-rules/aws-aidlc-rule-details/before the other rule-detail fallback paths.AGENTS.mdrepository context.AGENTS.mddiscovery andproject_doc_max_bytes.npm exec --yes --package markdownlint-cli2 -- markdownlint-cli2 README.md(0 error(s)).git diff --check.Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.