[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [che-dev] Conventional commits
|
Hello Mario,
On 6/15/21 12:41 PM, Mario Loriedo wrote:
As mentioned during yesterday's community call we should have a
discussion about conventional commits [1] to decide if we should enforce
it or not.
Currently a PR check verifies if commits messages follow the convention.
PRs can be merged even if the check fails. But we need to decide if we
are going to enforce the convention (block PRs where the check fails,
update the contribution guide etc...) or remove the PR check and
let contributors free to use any commit message format they like.
What's your thoughts?
[1] https://www.conventionalcommits.org/
<https://www.conventionalcommits.org/>
I'd prefer it if we didn't police commit message titles. There isn't
really a functional difference between "Remap redhat/java plugin to
point to java8" versus "fix(plugins): remap redhat/java to point to java8".
If we're proposing this as a way to generate the changelog then I'd
caution against that. It is generally considered bad form to dump
commits into a file and call it a changelog. [1] Instead I would suggest
we have a small markdown file in which developers can document
meaningful changes near release time. In GNU projects this is the NEWS
file, or for example Eclipse's Release Notes document. [2]
1: https://keepachangelog.com/en/1.0.0/
2: https://www.eclipse.org/eclipse/development/readme_eclipse_4.20.php
Eric
