V0.7.4/git keep a changelog - #29
Merged
Merged
Conversation
…mit coverage Restructure the skill workflow to make base-commit inspection (Step 4a) a mandatory gate for concrete releases, enforce the use of <base>^..HEAD syntax to include foundational version bumps and release-prep changes, and explicitly report what was found before proceeding to manifest diffs. Add validator assertions to ensure the skill documentation covers this critical requirement. Add eval test case to verify the behavior.
Update the skill description in the README to highlight the new concrete-release base-commit coverage requirement and mandate the <base>^..HEAD syntax to ensure foundational version bumps and release-prep changes are never omitted from release changelogs.
Rename the validation section in the git-keep-a-changelog skill from 'Pre-Step 4 Validation' to 'Step 3b: Verify Your Approach' to clarify its workflow position. Update the corresponding validator assertion and remove a trailing edge-case note.
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
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.
This pull request makes significant improvements to the
git-keep-a-changelogskill to ensure concrete release changelogs always include the base commit, preventing accidental omission of foundational changes such as version bumps and release-prep updates. The documentation, evaluation criteria, and validation scripts are all updated to enforce and clarify this requirement, adding explicit instructions, checks, and examples for using<base>^..HEAD(with the caret) for concrete releases.Changelog and Documentation Improvements:
README.mdandskills/git-keep-a-changelog/SKILL.mdto emphasize that for concrete releases, Step 4 must use<base>^..HEADto include the base commit, with detailed explanations, examples, and explicit pre-Step 4 validation instructions. This ensures foundational changes are never omitted from the release changelog. [1] [2] [3] [4] [5]Validation and Evaluation Enhancements:
scripts/validate-skill-templates.ps1to check that the skill documentation and evaluation files require and describe the use of<base>^..HEADfor concrete releases, including explicit pre-Step 4 validation and reporting of the base commit. [1] [2]skills/git-keep-a-changelog/evals/evals.jsonwith a new evaluation scenario to verify that the workflow recognizes concrete releases, uses the correct commit range, and reports/analyzes the base commit before proceeding.