Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 3.28 KB

README.adoc

File metadata and controls

95 lines (65 loc) · 3.28 KB

Gommitlint

Tag MPL 2.0 REUSE OpenSSF Scorecard

What can this tool do for you?

Gommitlint will be a CLI-tool for validating commit messages. At the moment it is not ready for usage.

Example validations are:

  • Commit message header length

  • Developer Certificate of Origin

  • GPG signature

  • GPG signature identity check

  • Imperative mood

  • Jira issue check

  • Maximum of one commit ahead of master

  • Require a commit body

  • Spell check

  • Conventional Commits

Where can you use it?

  • As a CLI-tool

  • In your CI/CD-pipelines

Getting Started

TODO

Make Gommitlint better?

ED: Currently I’m not reading PRs as there is few base things to fix before that.

Here’s how you can contribute:

For developers

TODO

What’s next?

Check out our Issues page.

A friendly reminder

Please Note: Gommitlint is currently in Alpha. This means:

  • Things might change in breaking ways.

  • Feel free to share ideas on how we can make it better.

Gommitlint will slowly getting stable and reliable. But as with any tool in early stages, it’s always good to be careful!

Credits & History

Gommitlint is a hard fork of Sidero Labs Conform tool. All the heavy base work was made by them, so many creds and thanks for that.

That also means that the whole project will continue to be under the Mozila Public License, as that is the license of the most of the code base. I’m not planning to rewrite the code 100% just to be able to use another license.

Gommitlint is licensed under the Mozilla Public License 2.0.

Most of the non-code bits are under Creative Commons CC0-1.0.

For all the details, check out our LICENSE file and the headers in each file.