[docs] Capture session lessons into pr-workflow / memory-rules / conftest notes#48
Merged
Merged
Conversation
…test notes Four lessons surfaced during the M5b chart work that are durable enough to outlive the session. Each lands in a new topic note with an anchor the next contributor can grep for to catch regression: - pr-workflow: update the PR body each review round (not just at open), because the squash-merge body is what becomes permanent on main; iterative reviews need each round's prompt to enumerate prior-round artifacts so the next pass surfaces residual gaps rather than re-reporting closed findings. - memory-rules: when a memory rule tightens and collides with an existing constraint (e.g. AI-trailer cleanup vs. no-history-rewrites on already-pushed commits), name forward-only compliance as the resolution in the offending file so the next contributor does not relitigate. - conftest: rego deny rules that reference `pod_spec.<field>` fire on non-pod documents (ConfigMap, ServiceAccount, Secret) unless guarded with `input.spec.template.spec`, because rego's undefined-propagation rules make `not pod_spec.x == true` evaluate true when pod_spec is absent. AGENTS.md topic index gains three pointers (one per new note). Skill format check clean: no banned vocabulary, no AI attribution, anchors present on every entry, AGENTS.md at 36 lines (cap 150). Signed-off-by: Tri Lam <trilamsr@gmail.com>
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
1 participant
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.
Problem
Four durable lessons surfaced during the M5b chart work (PR #29 +
follow-up #36) were not recorded in repo-resident notes.
Impact
Without anchors in
docs/notes/, the next contributor re-discoversthe same patterns: PR bodies drift across review rounds, memory-rule
collisions get relitigated, rego rules fire on non-pod documents,
iterative reviews repeat prior findings.
Solution
Three new topic notes under
docs/notes/, each with anchors thatcatch regression:
pr-workflow.md— body-sync per review round + iterative-reviewprompt discipline.
memory-rules.md— forward-only compliance as the resolution forrule collisions.
conftest.md—input.spec.template.specguard on every regodeny rule that references pod-spec fields.
AGENTS.mdtopic index gains one line per new note. Captured via thelearn-from-mistakesskill — banned-vocabulary check clean, AIattribution clean, anchors present, AGENTS.md at 55/150 lines.
This PR replaces #41, which was opened off a now-stale base. Closing
#41 in favor of this branch keeps history append-only per the
project's no-rebase-after-push rule.
Test plan
make doc-checkclean post-rebase (202 markdown links resolve).pr-lintgreen.verifyjob unchanged.