docs: add conventional commits guidance to Contributing section#62
Merged
semarj merged 1 commit intoShipEngine:mainfrom May 6, 2026
Merged
Conversation
Explains how commit message format drives release-please automation and ultimately PyPI publishing. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
semarj
approved these changes
May 6, 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
2 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.
Adds a new "Commit Messages" subsection to the Contributing section of the README explaining how Conventional Commits drive the release-please automation and PyPI publishing pipeline.
Motivated by my recent PRs whose commit messages didn't follow the required format, resulting in nothing being published to PyPI. Hoping this saves future contributors from running into the same issue.