Skip to content

This is a project that allows generating commit messages with good practices, based on the commit messages used in the Linux repository. It uses the OpenAI API.

Notifications You must be signed in to change notification settings

wdavidcalsin/commit-genius

Repository files navigation

Grammar logo

COMMIT GENIUS

This is a project that allows generating commit messages with good practices, based on the commit messages used in the Linux repository.

Grammar logo

Features

  • Generation of commits with good practices based on the commit messages used in the Linux repository.
  • Simple and user-friendly interface that allows entering the infinitive verb, object, and description of the commit.
  • Automatically generated commit message with a structured and readable format.
  • Option to copy the generated commit message to the clipboard.

Installation

To install the project locally, follow these steps:

  • Clone this repository on your local machine.

    git clone https://github.com/tu-usuario/tu-repositorio.git
  • Install project dependencies:

    cd commit-genius
    pnpm install

    or

    npm install
  • Run to start the application.

    pnpm dev

    or

    npm run dev
  • Open your browser and navigate to http://localhost:3000/ to view the application.

Technologies Used

  • Next.js
  • TypeScript
  • Chakra-ui

Contributing

If you would like to contribute to this project, please open an issue or send a pull request. We are happy to review your contributions!

License

This project is licensed under the MIT License.

About

This is a project that allows generating commit messages with good practices, based on the commit messages used in the Linux repository. It uses the OpenAI API.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages