docs(github-pr-workflow): require system-consequence section in every PR#84
Merged
Merged
Conversation
Every PR (Sam's repo or any work repo) now opens with a concrete account of what changes in the running system because of this PR. One line per observable change, consequence-first, artifact at end-of-line. Reviewers can decide without opening the diff; future readers searching `git log` find what each PR did in prose, not by diffing files. Ties to the README's first motivation — writing requirements at the same abstraction level as code lands HERE: the PR description is where the new requirement / capability / constraint gets stated in operator-level prose. Skip only for typo fixes and one-line doc edits.
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.
What this changes
src/skills/github-pr-workflow/skill.mdgit log/ PR history find what each PR did in operator-level prose, not by diffing filesdembrane/samWhy this fits Sam's mission
The README's first motivation — writing requirements is at (almost) the same abstraction level as writing code — lands here. The PR description is where the new requirement, the new capability, the new constraint gets written in operator-level prose so the next person (or future-Sam reading
git log) finds the what changed without having to reconstruct it from the diff.This PR is itself the first artifact under the new rule. The "What this changes" section above is the format.
Confidence
High. Docs-only change to one skill file. No runtime behavior; existing 181 tests pass unchanged.