Feature request: `commitizen` should support revert commits

[lucatrv]

I know that a similar request was discussed before, however angular does contemplate revert commits.

As a minimum, cz check should accept commit messages beginning with revert:, otherwise when it is configured as a pre-commit hook it does not allow revert commits.

Moreover, IMHO a cz revert command should be added, accepting the <commit> to revert. It should run git revert <commit>, including in the message body: This reverts commit <hash>. as per angular instructions. See information on git revert.

For examples of revert commit messages, see for instance standard-version and conventional-changelog commit logs.

Notice that both commitlint and gitlint support revert commits.

[lucatrv]

I add that IMHO, other than revert, also the chore type should be added. In fact the Conventional Commits website clarifies that their specifications are inspired by the Angular Commit Guidelines (so not identical), and reports as an example the @commitlint/config-conventional recommendations, which include also chore and revert types.

Edit: after some deeper research, I now agree that chore is unnecessary, as it is being replaced by build. This is also explained in this guide. So please disregard this last post, while I confirm the feature request for revert.

[lucatrv]

I now noticed the following definition of the schema_pattern function in conventional_commits.py:

def schema_pattern(self) -> str:
    PATTERN = (
        r"(build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)"
        r"(\(\S+\))?:\s.*"
    )
    return PATTERN

So it includes both revert and chore.

[Lee-W]

To have revert and chore type, we'll have to add it here as well.

[Lee-W]

As for command like cz revert, we can add a command under commitizen/commands. By doing so, we might need to also consider the default behavior for the cz that does not have revert type (e.g., cz_jira)

[woile]

To have revert and chore type, we'll have to add it here as well.

I wouldn't add them, those 2 are added to the "pattern" in order to prevent backward errors, but officially they are not part of conventional commits, we are using the latest types from Angular (they used to but were removed).Using chore or revert would be part of a different custom rule.

Regarding the revert commit, I'm not really sure if we want to add a whole new command because it would be pretty much useless for any other "rule" like jira. And it can be achieved by doing:

git revert --no-commit <SHA>
git commit -m "revert: foo bar"

[Lee-W]

When checking the commit message through cz check, I skip Merge and Revert. Thus, this won't be a problem.

[Lee-W]

This issue is raised more than one time (I had the same question when I first use commizen as well.) Maybe we could consider adding it to FAQ in documentation?

[lucatrv]

OK, in this case I would document it in README.md after the "Help" section, maybe in a new section titled "How to handle revert commits?" or similar. It could reference the corresponding section on the Conventional Commits website, and report the two commands suggested above.

[Lee-W]

Thanks for the feedback 🙂 I just added it to the FAQ. I'll close this issue.