This is about the guidance for contributions to cargo-smart-release itself, as presented in CONTRIBUTING.md.
It's not entirely clear if the following is just referring to the use of conventional commits or if it means more than that such as each commit having a clear scope, or making sure multiple commits aren't use when only one is sufficient, or making sure multiple commits are used when multiple changes are being made:
Before posting a PR, we request that the commit history get cleaned up.
This can't be inferred because not all projects have the same expectations regarding this, and the matter is subjective, such that there is no clear best general approach.
More significantly, this seems like it might potentially be misleading:
For commit messages, we use Conventional style.
Looking at the commit history for this repository, it looks like there are a number of commits that would be in conventional style in projects that make strict use of conventional commit style, but that are intentionally not conventional here.
Since the biggest user of cargo-smart-release is gitoxide, people (like me) who come here from there may be unsure if the style preferred here is full use of conventional commits, or instead the "purposeful conventional commits" style used there, or some other style.
(I was originally going to post a discussion question to ask this, but I figured that CONTRIBUTING.md might benefit from including the clarification, so I decided to open this issue instead.)
This is about the guidance for contributions to
cargo-smart-releaseitself, as presented inCONTRIBUTING.md.It's not entirely clear if the following is just referring to the use of conventional commits or if it means more than that such as each commit having a clear scope, or making sure multiple commits aren't use when only one is sufficient, or making sure multiple commits are used when multiple changes are being made:
This can't be inferred because not all projects have the same expectations regarding this, and the matter is subjective, such that there is no clear best general approach.
More significantly, this seems like it might potentially be misleading:
Looking at the commit history for this repository, it looks like there are a number of commits that would be in conventional style in projects that make strict use of conventional commit style, but that are intentionally not conventional here.
Since the biggest user of cargo-smart-release is gitoxide, people (like me) who come here from there may be unsure if the style preferred here is full use of conventional commits, or instead the "purposeful conventional commits" style used there, or some other style.
(I was originally going to post a discussion question to ask this, but I figured that
CONTRIBUTING.mdmight benefit from including the clarification, so I decided to open this issue instead.)