{{ message }}
feat(cli): add description when choosing a commit rule - #1825
Merged
Lee-W merged 8 commits intoJan 31, 2026
Conversation
github-actions
Bot
added
pr-status: wait-for-review
type: feature
namwoam
force-pushed
the
add-commit-rule-doc
branch
from
January 31, 2026 05:01
7b4c8d6 to
aef0171
Compare
| return questionary.Choice( | ||
| title=cz_name, value=cz_name, description=f"{first_example}" | ||
| ) | ||
| except Exception: # pylint: disable=broad-except |
Collaborator
There was a problem hiding this comment.
quick question: what are possible exceptions
the try: block should be as small as possible
Contributor
Author
There was a problem hiding this comment.
cz_obj = cz_class(self.config) could cause exception MissingCzCustomizeConfigError for cz_customize, fixed except statement
bearomorphism
added
pr-status: wait-for-modification
and removed
pr-status: wait-for-review
labels
Lee-W
reviewed
Jan 31, 2026
Lee-W
left a comment
Lee-W
left a comment
Member
There was a problem hiding this comment.
hey, thanks for your contribution. This looks cool! would it be possible for us to add unit test here?
Member
There was a problem hiding this comment.
do we need to make it a function inside _ask_name?
Contributor
Author
There was a problem hiding this comment.
Added unittest for construct_choice_with_description
Lee-W
approved these changes
Jan 31, 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.
Closes #1822
Description
This PR adds descriptions to the commit message rule selection step.
Checklist
Was generative AI tooling used to co-author this PR?
Code Changes
uv run poe alllocally to ensure this change passes linter check and testsDocumentation Changes
uv run poe doclocally to ensure the documentation pages renders correctlyExpected Behavior
When selecting the commit rule at
cz init, it should appear a description when selecting a commit rule.Before:
After:
Additional Context
Issue: #1822