CHORE: add commit squashing and commit message guidance to contributing.md - #18
Merged
SaschaSchwarze0 merged 1 commit intoAug 9, 2026
Conversation
pull-request-size
Bot
added
the
size/M
openshift-ci
Bot
added
the
kind/documentation
SaschaSchwarze0
requested changes
Aug 3, 2026
kaizakin
force-pushed
the
doc/add-contributor-guidelines
branch
2 times, most recently
from
August 3, 2026 13:36
45e8fcc to
4aa5414
Compare
IrvingMg
reviewed
Aug 9, 2026
…ng.md Signed-off-by: karthik balasubramanian <karthikbalasubramanian08@gmail.com>
kaizakin
force-pushed
the
doc/add-contributor-guidelines
branch
from
August 9, 2026 14:55
4aa5414 to
d6f934b
Compare
IrvingMg
reviewed
Aug 9, 2026
| changes into the relevant commit before requesting review, or as part of addressing review | ||
| feedback prior to merge. | ||
|
|
||
| - Write commit messages following the [Conventional Commits](https://www.conventionalcommits.org/) specification. |
Member
There was a problem hiding this comment.
I’m wondering whether we want Conventional Commits to be a requirement or just a recommendation. Are we already enforcing them anywhere?
If they’re meant to be required, should we have a hook or check to validate commit messages? If not, then this is probably fine as-is.
Either way, it’d be good to get a maintainer’s take on the intended approach.
Contributor
Author
There was a problem hiding this comment.
@IrvingMg Me and sascha had a discussion over this. Considering we do release notes based on the release notes box it's not really needed to enforce conventional commits.
I've just added it as a recommendation because many projects follow them. and Adam's suggestion here shipwright-io/cli#355 (comment)
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
4 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.
Changes
shipwright-io/cli#355 (comment)
based on this comment by Adam I'm suggesting to add these into the contributing.md
Type of PR
/kind documentation
Submitter Checklist
See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.
Release Notes