lint commit

Lint Commit

Beschreibung

Dieses CLI -Tool hilft bei der Automatisierung des Prozesses des Generierens von Festschriftennachrichten und der Verwaltung eines Git -Repositorys. Es führt den Benutzer durch die Initialisierung eines Git-Repositorys (falls bereits initialisiert), die Auswahl von Dateien für die Festlegung, das Generieren von AI-unterstützten Festschriftennachrichten und die optional Drücken von Änderungen an einem Remote-Repository.

Merkmale

• Initialisieren Sie ein neues Git -Repository, wenn es nicht bereits initialisiert wurde
• Wählen Sie Dateien aus, die aus der Liste der geänderten Dateien festgelegt werden können
• Generieren Sie AI-unterstützte Festungsnachrichten mithilfe der Google Generative AI API
• Drücken Sie optional Änderungen an das Remote -Repository

Voraussetzungen

• Node.js (v14.x oder höher)
• Git auf Ihrem System installiert
• Github CLI ( gh ) installiert
• Google Generative AI API -Schlüssel: Google AI Studio

Installation

1. Installieren Sie das Lint-Commit weltweit:

npm install -g lint-commit

2. Registrieren Sie Ihren Gemini_API_Key:

lint-commit register

3. Alternativ können Sie dieses Repository klonen und das Skript lokal ausführen:

git clone https://github.com/techwithmanuel/lint-commit.git
cd lint-commit
npm install
node register.js
node index.js

So erhalten Sie Ihren Gemini -API -Schlüssel

1. Melden Sie sich bei Google AI Studio an

2. Wählen Sie Get API key

3. Wählen Sie Create API key und befolgen Sie die Eingabeaufforderung, um den Schlüssel zu erstellen

4. Nach Abschluss kopieren Sie den Schlüssel, führen Sie diesen Befehl nach der Installation von Lint-Commit aus

 lint-commit register

Geben Sie dann den Schlüssel ein

Verwendung

Sobald Sie Ihren GEMINI_API_KEY installiert und wieder auferlegt haben, um mit Lint-Commit zu beginnen, rennen Sie einfach:

lint-commit

Befolgen Sie die Eingabeaufforderungen, ein Git-Repository zu initialisieren, Dateien hinzuzufügen und einen Commiting mit einer Commit-Lint-Konformanten-Nachricht zu erstellen.

Beitragen

Beiträge sind willkommen! Bitte befolgen Sie diese Schritte, um einen Beitrag zu leisten:

1. Geben Sie das Repository auf.
2. Erstellen Sie eine neue Filiale (Git Checkout -B -Feature -Branch).
3. Nehmen Sie Ihre Änderungen vor und verpflichten Sie sie (Git Commit -am 'Neue Funktion hinzufügen').
4. Drücken Sie in den Zweig (Git Push Origin Feature-Branch).
5. Erstellen Sie eine neue Pull -Anfrage.

Kontakt

Für Fragen oder Vorschläge öffnen Sie bitte ein Problem.