Skip to content

Conversation

@xrvdg
Copy link
Contributor

@xrvdg xrvdg commented Sep 4, 2025

Adds advice on writing commit message to the contributing guide. This PR also acts as a test for the merging strategy to see if it has been setup correctly for smashing fixup commits.

@Oghma feel free to add your suggestions as well.

@xrvdg xrvdg requested a review from Oghma September 4, 2025 09:22
@xrvdg xrvdg requested a review from a team as a code owner September 4, 2025 09:22
Copy link
Collaborator

@maksimryndin maksimryndin left a comment

Choose a reason for hiding this comment

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

Awesome @xrvdg ! 👍

@Oghma
Copy link
Contributor

Oghma commented Oct 9, 2025

Personally, I like this convention https://www.conventionalcommits.org/en/v1.0.0/ with a scope.
The scope is the module/crate you are working on.

@xrvdg I had put it as a comment. What do you think?

@xrvdg
Copy link
Contributor Author

xrvdg commented Oct 13, 2025

Personally, I like this convention https://www.conventionalcommits.org/en/v1.0.0/ with a scope. The scope is the module/crate you are working on.

@xrvdg I had put it as a comment. What do you think?

I'm not a fan of that convention after having been on a couple of projects that used it. I found the structure to not help me, and even hindering me, in writing informative and succinct commit messages.

I like to set context directly at the beginning as it helps me with writing succinct commit message and scanning through commit logs. Context can be seen as scope, but not all projects I've been on see scope in the same way. I dislike the type annotation, it makes my eyes just glaze over the logs.

Furthermore this convention tends to come with poor linters making the whole thing a faff. Overly strict on non-important things and messing with what I can write as scope/context.

I prefer freer prose with in the the beginning a context keyword the commit author came up with over a rigid structure.

@maksimryndin
Copy link
Collaborator

should we merge it @xrvdg ?

@xrvdg xrvdg merged commit 386f798 into main Nov 10, 2025
8 checks passed
@xrvdg xrvdg deleted the xr/commit-message branch November 10, 2025 02:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants