https://github.com/itiquette/gommitlint

A commitlint tool, wip
https://github.com/itiquette/gommitlint

Last synced: over 1 year ago
JSON representation

A commitlint tool, wip

• Host: GitHub
• URL: https://github.com/itiquette/gommitlint
• Owner: itiquette
• License: eupl-1.2
• Created: 2024-10-07T19:16:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-24T11:54:56.000Z (over 1 year ago)
• Last Synced: 2025-03-27T06:53:29.874Z (over 1 year ago)
• Language: Go
• Homepage:
• Size: 75.2 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
// SPDX-FileCopyrightText: Josef Andersson

//

// SPDX-License-Identifier: CC0-1.0

= Gommitlint

:revdate: {docdatetime}

:doctype: article

:imagesdir: assets

:source-highlighter: rouge

ifdef::env-github[]

:tip-caption: :bulb:

:note-caption: :information_source:

:important-caption: :heavy_exclamation_mark:

:caution-caption: :fire:

:warning-caption: :warning:

endif::[]

image:https://img.shields.io/github/v/tag/itiquette/gommitlint?style=for-the-badge&color=yellow[Tag,link=https://github.com/itiquette/gommitlint/tags]

https://scorecard.dev/viewer/?uri=github.com/itiquette/gommitlint[image:https://api.scorecard.dev/projects/github.com/itiquette/gommitlint/badge?style=for-the-badge[OpenSSF Scorecard]]

link:LICENSE[image:https://img.shields.io/badge/License-EUPL%201.2-blue?style=for-the-badge[EUPL 1.2]]

image:https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.reuse.software%2Fstatus%2Fgithub.com%2Fitiquette%2Fgommitlint&query=status&style=for-the-badge&label=REUSE[REUSE,link=https://api.reuse.software/info/github.com/itiquette/gommitlint]

== What can this tool do for you?

*Gommitlint* will be a simple CLI-tool for validating commit messages.

At the moment it is not ready.

Available validation rules:

** Is https://www.conventionalcommits.org[Conventional Commits]

** Commit message subject length

** Commit has Sign-Off

** Signature

** Signature identity check

** Imperative 

** Jira Key Exists

** Maximum of N commit ahead comparing branch

** Require Commit body

** Spell check

== Where can you use it?

* As a CLI-tool

* In a CI/CD-pipeline

== Getting Started

TODO

//1. Check out the link:docs/usage.adoc[Usage Guide] for a quick start.

// 2. The link:INSTALL.adoc[Installation Guide] will get you up and running.

== 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:

* Found a bug or have a great idea? Let us know in our https://github.com/itiquette/gommitlint/issues[Issue Tracker]

* Want to contribute code? Check out our link:CONTRIBUTING.md[Contribution Guide] to get started.

== For developers

TODO

//If you're interested in how it works, see the link:DEVELOPMENT.adoc[Development Guide].

== What's next?

Check out our https://github.com/itiquette/gommitlint/issues[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.

== Credits & History

Gommitlint was inspired by Sidero Labs https://github.com/siderolabs/conform[Conform tool].

== Legal Stuff

Gommitlint is licensed under the EUPL 1.2 License.

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

For all the details, check out our link:LICENSE[LICENSE] file and the headers in each file.