Align commit-message generation prompt with OpenStack commit message best practices#16
Merged
Merged
Conversation
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/8b6e28a3-fef2-41f0-bb1a-3773ad2970ef Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
electrocucaracha
May 17, 2026 22:13
View session
electrocucaracha
requested changes
May 17, 2026
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/42f30900-f245-4e9b-81af-ff3aebaf62b1 Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the default commit-message prompt and README wording to align generated messages with OpenStack-style commit-message guidance, while adding the new proper noun to the spellcheck wordlist.
Changes:
- Revises body guidance in the default prompt toward concise problem/change/impact prose.
- Updates README positioning from Google engineering practices to OpenStack commit-message practices.
- Adds
OpenStackto the custom spellcheck wordlist.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/ai_prepare_commit_msg/prompts/default.yml |
Updates commit-message generation rules for headers, body structure, and validation. |
README.md |
Documents the project’s commit-message style as OpenStack-oriented. |
.github/.wordlist.txt |
Allows OpenStack in spellcheck validation. |
Agent-Logs-Url: https://github.com/electrocucaracha/ai-prepare-commit-msg/sessions/1e9dfe27-f991-4c4d-926c-42ac21810f6d Co-authored-by: electrocucaracha <2782150+electrocucaracha@users.noreply.github.com>
electrocucaracha
approved these changes
May 17, 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
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 PR aligns the default commit-message prompt with OpenStack-style guidance and resolves follow-up review feedback for consistency.
Changes Made
src/ai_prepare_commit_msg/prompts/default.ymlto refine commit-message guidance toward clear prose and consistent formatting rules.OpenStackto.github/.wordlist.txtto fix the spellcheck CI failure triggered byREADME.md.Validation
Run misspell).parallel_validation): Code Review passed and CodeQL reported trivial-change skip.