-
Notifications
You must be signed in to change notification settings - Fork 7
docs(loops): add README and changelog guidance to loop agents #41
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -227,7 +227,36 @@ Implement feature X following TDD: | |||||||||||||||||
| 7. Output: <promise>COMPLETE</promise> | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| ### 4. Escape Hatches | ||||||||||||||||||
| ### 4. Documentation Updates | ||||||||||||||||||
|
|
||||||||||||||||||
| Include documentation requirements in your completion criteria: | ||||||||||||||||||
|
|
||||||||||||||||||
| **README updates** - When adding features, APIs, or changing behavior: | ||||||||||||||||||
|
|
||||||||||||||||||
| ```text | ||||||||||||||||||
| Implement feature X. | ||||||||||||||||||
|
|
||||||||||||||||||
| When complete: | ||||||||||||||||||
| - Feature working with tests | ||||||||||||||||||
| - README.md updated with usage examples | ||||||||||||||||||
| - Output: <promise>COMPLETE</promise> | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| **Changelog via commits** - Use conventional commit messages for auto-generated changelogs: | ||||||||||||||||||
|
|
||||||||||||||||||
| ```text | ||||||||||||||||||
| # Good commit messages (auto-included in changelog) | ||||||||||||||||||
| feat: add user authentication | ||||||||||||||||||
| fix: resolve memory leak in connection pool | ||||||||||||||||||
| docs: update API documentation | ||||||||||||||||||
|
|
||||||||||||||||||
| # Excluded from changelog | ||||||||||||||||||
| chore: update dependencies | ||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| The release workflow auto-generates CHANGELOG.md from conventional commits. See `workflows/changelog.md`. | ||||||||||||||||||
|
|
||||||||||||||||||
| ### 5. Escape Hatches | ||||||||||||||||||
|
|
||||||||||||||||||
| Always use `--max-iterations` as a safety net: | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
@@ -542,13 +571,25 @@ The loop is designed for maximum AI autonomy while preserving human control at s | |||||||||||||||||
|
|
||||||||||||||||||
| | Phase | AI Autonomous | Human Required | | ||||||||||||||||||
| |-------|---------------|----------------| | ||||||||||||||||||
| | Task Development | Code changes, iterations, fixes | Initial task definition, scope decisions | | ||||||||||||||||||
| | Task Development | Code changes, iterations, fixes, README updates | Initial task definition, scope decisions | | ||||||||||||||||||
| | Preflight | Auto-fix, re-run checks | Override to skip (emergency only) | | ||||||||||||||||||
| | PR Creation | Auto-create with `--fill` | Custom title/description if needed | | ||||||||||||||||||
| | PR Review | Address feedback, push fixes | Approve/merge (if required by repo) | | ||||||||||||||||||
| | Postflight | Monitor, report issues | Rollback decision if issues found | | ||||||||||||||||||
| | Deploy | Run `setup.sh` | None (fully autonomous) | | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Documentation in Loops | ||||||||||||||||||
|
|
||||||||||||||||||
| **README updates**: Include in task development phase when adding features/APIs. | ||||||||||||||||||
|
|
||||||||||||||||||
| **Changelog**: Auto-generated from conventional commits during release. Use proper prefixes: | ||||||||||||||||||
| - `feat:` → Added section | ||||||||||||||||||
| - `fix:` → Fixed section | ||||||||||||||||||
| - `docs:` → Changed section | ||||||||||||||||||
| - `chore:` → Excluded from changelog | ||||||||||||||||||
|
Comment on lines
+586
to
+589
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. This list of commit prefixes is incomplete compared to the table in
Suggested change
|
||||||||||||||||||
|
|
||||||||||||||||||
| See `workflows/changelog.md` for details. | ||||||||||||||||||
|
|
||||||||||||||||||
| ### Options | ||||||||||||||||||
|
|
||||||||||||||||||
| ```bash | ||||||||||||||||||
|
|
||||||||||||||||||
Oops, something went wrong.
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.
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.
For consistency and completeness, it would be better to use the same comprehensive Markdown table for conventional commit prefixes as used in
.agent/scripts/commands/full-loop.md. The current list is missingperfandrefactorprefixes.