fix: improve AI version bump classification prompt#66
Open
Conversation
The default AI prompt had only a single vague line for semver guidance: 'Use patch for bug fixes, minor for features, major for breaking changes'. This led to removals of public API being classified as patch. Replaces it with explicit rules that enumerate what constitutes a breaking change (removal/rename of public functions, types, traits, modules, CLI flags, RPC methods, config fields, etc.) and instructs the LLM to choose major when in doubt between major and minor. Co-Authored-By: onbjerg <8862627+onbjerg@users.noreply.github.com>
Contributor
|
Repos can now override the default AI prompt by placing an instructions.md file in their .changelog/ directory. This lets repos define project-specific semver classification rules without needing to pass --instructions on every invocation. Priority: --instructions flag > .changelog/instructions.md > built-in default. Co-Authored-By: onbjerg <8862627+onbjerg@users.noreply.github.com>
This reverts commit 71e6c2e.
DaniPopes
approved these changes
Mar 12, 2026
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
3 participants
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.
The default AI prompt had only a single vague line for semver guidance:
Use patch for bug fixes, minor for features, major for breaking changesThis led to removals of public API being classified as
patch— e.g. removing a publicly reachable function would get tagged as a patch bump, when it's actually a breaking change.Replaces it with explicit rules that enumerate what constitutes each bump level:
Co-Authored-By: onbjerg 8862627+onbjerg@users.noreply.github.com
Prompted by: onbjerg