https://github.com/ruru-m07/commitly

Got messy commit messages? Our AI bot's here to save the day! It'll turn your changes into creative and clear commit messages. No more boring logs! ✨
https://github.com/ruru-m07/commitly

Last synced: 25 days ago
JSON representation

Got messy commit messages? Our AI bot's here to save the day! It'll turn your changes into creative and clear commit messages. No more boring logs! ✨

• Host: GitHub
• URL: https://github.com/ruru-m07/commitly
• Owner: ruru-m07
• License: mit
• Created: 2024-05-08T03:17:44.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-05-19T14:19:37.000Z (6 months ago)
• Last Synced: 2024-05-19T14:40:26.914Z (6 months ago)
• Language: TypeScript
• Homepage: https://commitly.vercel.app
• Size: 558 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


    



## 🌟 Commitly (Web): The Ultimate Git Commit Message Assistant.

- This web app helps you write informative and engaging git commit messages by providing suggestions based on your code changes.

## ✨ Features and Benefits:

- 🚀 Provides suggestions based on your code changes

- 📝 Helps you write clear and concise commit messages

- 📈 Improves the quality of your git history

- ⏰ Saves you time and effort

## 🤔 How to Use Commitly

1. Visit the [Commitly](https://commitly.vercel.app/) website.

2. Paste your code changes into the text box.

3. Click the `Generate` button.

> ![image](https://github.com/ruru-m07/commitly/assets/142723369/f4c8c94b-42c7-4a53-89a1-27542f90e47c)

4. Commitly will analyze your code changes and suggest a commit message.

5. You can edit the suggested message or use it as is.

6. Click the "Copy to Clipboard" button to copy the commit message.

> ![image](https://github.com/ruru-m07/commitly/assets/142723369/a2e13ef0-3ad3-4760-8af8-5cff56c538d7)

## ☘️ Contributing:

- Contributions are welcome! 💖 Please read the [contributing guidelines](https://github.com/ruru-m07/commitly/blob/main/CONTRIBUTING.md) before submitting a pull request.

## 🚀 Getting Started for Developers:

- Clone the repository: `git clone https://github.com/ruru-m07/commitly.git`

- Install the dependencies: `pnpm install`

- Set up `.env` file.

- Run the development server: `pnpm dev`

## ✅ License:

- [MIT](https://github.com/ruru-m07/commitly/blob/main/LICENSE)

## 😆 Feedback:

- Your feedback is valuable to us. Please share your thoughts and suggestions on how we can make Commitly better. [Feedback](https://github.com/ruru-m07/commitly/discussions/16)