commit linter

Commit-Linter

Ein einfach zu bedienendes Tool, das Ihre Feststellnachrichten entsprechend den Konventionen enthält.

Commit-Linter ist ein Python-Tool, mit dem Sie Ihre Commit-Nachrichten auf bekannte Commit-Konventionen standardisieren können. Das Tool fügt Ihren Commits auch Emojies hinzu.

Installation

Verwenden Sie den Paket-Manager-PIP, um Commit-Linter zu installieren.

pip install commit-linter

Verwendung

In Ihrem Git -Repository führen Sie einfach aus

commit-linter

oder

commit-linter install

Wenn Sie den Haken entfernen möchten, führen Sie einfach aus

commit-linter remove

Wie es funktioniert

Commit-linter verwendet Git-Hooks, die Skripte sind, die in jedem Repository vorhanden sind. Schauen Sie sich ein Repo an, das Sie haben, Sie haben ein .git -Verzeichnis, und im Inneren finden Sie das hooks .git/hooks Verzeichnis. Commit-linter legt nur ein einfaches Skript mit dem Namen commit-msg in dieses Verzeichnis und macht es ausführbar. Jedes Mal, wenn Sie eine Commit-Nachricht entsprechen, wird es gemäß den Konventionen.

Lesen Sie mehr über Git Hooks.

Beitragen

Pull -Anfragen sind willkommen. Für wichtige Änderungen öffnen Sie zuerst ein Problem, um zu besprechen, was Sie ändern möchten.

Lizenz

Dieses Tool steht unter MIT -Lizenz.