lint commit

Compromiso de pelusa

Descripción

Esta herramienta CLI ayuda a automatizar el proceso de generación de mensajes de confirmación y administrar un repositorio Git. Guía al usuario inicializando un repositorio Git (si ya no se inicializó), seleccionó archivos para confirmar, generar mensajes de confirmación asistidos por AI y opcionalmente presionando los cambios a un repositorio remoto.

Características

• Inicializar un nuevo repositorio de git si aún no se inicializa
• Seleccione archivos para confirmar en la lista de archivos cambiados
• Genere mensajes de confirmación asistidos por AIHA utilizando la API de AI generativa de Google
• Opcionalmente, presione los cambios en el repositorio remoto

Requisitos previos

• Node.js (v14.x o posterior)
• Git instalado en su sistema
• Github CLI ( gh ) instalado
• Clave de API de AI generativa de Google: Google AI Studio

Instalación

1. Instale el compromiso de pelusa a nivel mundial:

npm install -g lint-commit

2. Registre su gemini_api_key:

lint-commit register

3. Alternativamente, puede clonar este repositorio y ejecutar el script localmente:

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

Cómo conseguir tu llave de API de Géminis

1. Inicie sesión en Google AI Studio

2. Seleccione Get API key en el menú lateral

3. Seleccione Create API key y luego siga la solicitud para crear la clave

4. Una vez hecho, copie la clave, ejecute este comando después de instalar Lint-Commit

 lint-commit register

Luego ingrese la clave

Uso

Una vez que haya instalado y resgiterado su GEMINI_API_KEY , para comenzar con Lint-Commit, simplemente ejecute:

lint-commit

Siga las indicaciones para inicializar un repositorio de git, agregar archivos y crear una confirmación con un mensaje de conformante comprometido.

Que contribuye

¡Las contribuciones son bienvenidas! Siga estos pasos para contribuir:

1. Bifurca el repositorio.
2. Cree una nueva sucursal (rama de funciones de checkout -b).
3. Haga sus cambios y confídos (git commit -am 'Agregar nueva función').
4. Empuje a la rama (rama de características de origen de empuje de git).
5. Cree una nueva solicitud de extracción.

Contacto

Para cualquier pregunta o sugerencia, abra un problema.