-
Notifications
You must be signed in to change notification settings - Fork 0
refactor: purge internal review artifacts and harden review flows #2
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 | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -32,15 +32,10 @@ Use this checklist before cutting any alpha or beta release of `codex-auto-memor | |||||||||||||||||||||||||||||||||||
| - `cam forget "..."` | ||||||||||||||||||||||||||||||||||||
| - `cam doctor` | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| ## Review packet checks | ||||||||||||||||||||||||||||||||||||
| ## Documentation checks | ||||||||||||||||||||||||||||||||||||
|
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. P2: The renamed section removes the CHANGELOG update checklist item, but the "Release decision" section at the bottom of this file still gates releases on "changelog is updated" and "review artifacts are in place." Either add a CHANGELOG bullet back under this section or update the release decision criteria to match. Prompt for AI agents |
||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| - Update `CHANGELOG.md` with the new milestone and commit hash. | ||||||||||||||||||||||||||||||||||||
| - Update `docs/progress-log.md` to reflect the current phase and remaining gaps. | ||||||||||||||||||||||||||||||||||||
| - Update `docs/review-guide.md` if a new high-risk area or review order is introduced. | ||||||||||||||||||||||||||||||||||||
| - Update `docs/reviewer-handoff.md` so external review tools can pick up the current state quickly. | ||||||||||||||||||||||||||||||||||||
| - Update the bilingual docs entry pages (`docs/README.md` and `docs/README.en.md`) if the public reading path changed. | ||||||||||||||||||||||||||||||||||||
| - Re-check the current official Codex and Claude public docs before changing migration wording; if the public posture is unchanged, say so explicitly in the handoff. | ||||||||||||||||||||||||||||||||||||
| - Refresh the local ignored AI handoff file `AI_REVIEW.local.md` with current review/test instructions before handing off to another agent. | ||||||||||||||||||||||||||||||||||||
| - Ensure the latest milestone commit is focused enough to review independently. | ||||||||||||||||||||||||||||||||||||
|
Comment on lines
+35
to
39
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. Documentation checks now underspecify release-gate prerequisites. The checklist still gates release on changelog/review artifacts later, but this section no longer tells maintainers to prepare them explicitly. Please add a direct prep step here to avoid release-time ambiguity. Suggested patch ## Documentation checks
- Update the bilingual docs entry pages (`docs/README.md` and `docs/README.en.md`) if the public reading path changed.
- Re-check the current official Codex and Claude public docs before changing migration wording; if the public posture is unchanged, say so explicitly in the handoff.
+- Confirm where release notes/changelog updates are recorded for this milestone and update them before tagging.
+- Confirm required reviewer artifacts for this milestone are present at their current canonical location.
- Ensure the latest milestone commit is focused enough to review independently.Based on learnings: "Keep release hygiene explicit about paired bilingual public-doc checks and companion-first wording". 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
| ## Native compatibility checks | ||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||
Uh oh!
There was an error while loading. Please reload this page.
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.
P2:
CHANGELOG.mdis a standard project-level file name that most release tooling and contributors expect to be tracked. The other entries in this block are clearly internal artifacts, but gitignoringCHANGELOG.mdwill silently prevent any future public changelog from being committed. Consider using a more specific name for the internal artifact (e.g.,AI_CHANGELOG.md) or removing this entry now that the internal file is already purged from history.Prompt for AI agents