-
Notifications
You must be signed in to change notification settings - Fork 39
docs: improve agent instructions based on session review #31
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -226,6 +226,49 @@ path/to/false-positive.txt | |||||
| .agent/scripts/version-manager.sh bump patch | ||||||
| ```text | ||||||
|
|
||||||
| ## Worktree Awareness | ||||||
|
|
||||||
| When running preflight in a worktree, checks run against the **worktree's files**, not the deployed `~/.aidevops/agents/` version. This means: | ||||||
|
|
||||||
| - Pre-existing issues in the deployed version won't be fixed by worktree changes | ||||||
| - Issues will only be resolved after merge and redeployment (`./setup.sh`) | ||||||
| - Focus on issues introduced by your changes, not inherited technical debt | ||||||
|
|
||||||
| ## Pre-existing vs New Issues | ||||||
|
|
||||||
| Preflight checks report ALL issues, including pre-existing ones. When the loop hits max iterations or you see many violations: | ||||||
|
|
||||||
| ### Identifying New vs Pre-existing Issues | ||||||
|
|
||||||
| ```bash | ||||||
| # See what files you changed | ||||||
| git diff main --name-only | ||||||
|
|
||||||
| # Check issues only in your changed files | ||||||
| shellcheck $(git diff main --name-only -- '*.sh') | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||
| ``` | ||||||
|
|
||||||
| ### When to Proceed Despite Issues | ||||||
|
|
||||||
| If all remaining issues are **pre-existing** (not introduced by your PR): | ||||||
|
|
||||||
| 1. Verify your changes don't add new violations | ||||||
| 2. Document pre-existing issues for future cleanup | ||||||
| 3. Proceed with PR creation | ||||||
| 4. Note in PR description: "Pre-existing issues not addressed in this PR" | ||||||
|
|
||||||
| ### When to Fix Issues | ||||||
|
|
||||||
| Fix issues that are: | ||||||
| - Introduced by your changes | ||||||
| - In files you're already modifying | ||||||
| - Quick wins (< 5 minutes to fix) | ||||||
|
|
||||||
| Defer issues that are: | ||||||
| - Pre-existing in untouched files | ||||||
| - Require significant refactoring | ||||||
| - Outside the scope of your PR | ||||||
|
|
||||||
| ## Related Workflows | ||||||
|
|
||||||
| - **Version bumping**: `workflows/version-bump.md` | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Worktree Awareness(and the rest of this new section) appears to follow a fenced block that’s closed withtext rather than a bare, which can cause everything after to render as a code block in Markdown. Worth double-checking the fence closures in this area so the new headings/sections render correctly.🤖 Was this useful? React with 👍 or 👎