-
Notifications
You must be signed in to change notification settings - Fork 40
docs(loops): add README and changelog guidance to loop agents #48
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 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -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 conventional commit prefixes is inconsistent with the more detailed table provided in
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| See `workflows/changelog.md` for details. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ### Options | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
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.
This line, along with others in this PR (e.g., line 176 in this file, and lines 257 and 591 in
.agent/workflows/ralph-loop.md), references aworkflows/changelog.mdfile. This file doesn't appear to be included in this pull request or the repository context provided. To prevent broken links and ensure users can find the detailed information, could you please add this file? If it's intended for a future PR, it might be helpful to clarify that.