Skip to content

CHORE: add commit squashing and commit message guidance to contributing.md #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SaschaSchwarze0 merged 1 commit into from
Aug 9, 2026
Merged

CHORE: add commit squashing and commit message guidance to contributing.md #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 40 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ All contributors must abide by our [Code of Conduct](/CODE_OF_CONDUCT.md).

The core code for Shipwright is located in the following repositories:

* [build](https://github.com/shipwright-io/build) - the Build APIs and associated controller to run builds.
* [cli](https://github.com/shipwright-io/cli) - the `shp` command line for Shipwright builds
* [operator](https://github.com/shipwright-io/operator) - an operator to install Shipwright components on Kubernetes via OLM.
- [build](https://github.com/shipwright-io/build) - the Build APIs and associated controller to run builds.
- [cli](https://github.com/shipwright-io/cli) - the `shp` command line for Shipwright builds
- [operator](https://github.com/shipwright-io/operator) - an operator to install Shipwright components on Kubernetes via OLM.

Technical documentation is spread across the code repositories, and is consolidated in the [website](https://github.com/shipwright-io/website) repository.
Content in `website` is published to [shipwright.io](https://shipwright.io)
Expand Down Expand Up @@ -65,6 +65,43 @@ We recommend you do the following to ensure the maintainers can collaborate on y
git commit --amend -s
```

- Before opening your pull request, squash your commits into a small number of logical,
reviewable units (ideally a single commit for small changes). This keeps the project history
clean and makes the change easier to review, bisect, and revert if needed. You can squash
commits with an interactive rebase against the branch point:

```sh
git fetch upstream # fetch the changes from remote
git rebase -i upstream/main
```

Avoid "fixup", "typo", or "address review comments" commits in the final history; fold those
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.

@IrvingMg IrvingMg Aug 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@kaizakin kaizakin Aug 9, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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)

Each commit message should be structured as:

```
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
```

Commonly used types include:
- `feat`: a new feature
- `fix`: a bug fix
- `docs`: documentation only changes
- `test`: adding or correcting tests
- `refactor`: a code change that neither fixes a bug nor adds a feature
- `chore`: changes to tooling, dependencies, or other maintenance tasks

For example: `fix(controller): requeue BuildRun on transient API errors`.
This convention makes the commit history easier to scan, and helps
reviewers understand the intent of a change at a glance.

- Push your code changes to GitHub, then [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
with a clear title for the community review. Most Shipwright repositories use templates to
generate pull request descriptions. If so, please fill out all sections so your change is
Expand Down