Skip to content

BishoyHanyRaafat/autocommit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pieces CLI for Developers

Pieces Autocommit tool

Pieces autocommit tool is very powerful tool that can be used to automate commiting by generating a commiting message. It is powered by Pieces OS Python SDK

Getting Started

  1. Install the project

    pip install git+https://github.com/BishoyHanyRaafat/autocommit.git
  2. Stage the changes:

    git add .
  3. Generate the commit message:

    autocommit

Dependencies

  • websocket
  • pieces_os_client

Overview

This tool is designed to automate the process of committing changes to your codebase. It not only commits your staged changes but also generates a commit message for you. If there is an issue related to the commit, the tool will automatically add the issue number to the commit message.

The tool automatically commits changes made to the codebase. This eliminates the need for manual intervention, making the process more efficient and less prone to errors.

Features

Commit Message Generation

The tool generates a commit message for each commit. This feature is designed to provide meaningful context for each commit without the need for manual input.

Issue Number Addition

If there is an issue related to the commit, the tool will automatically add the issue number to the commit message. This helps in tracking the progress of issues and linking commits to specific issues.

Demo

The generated commit message is:

 Add: the issue name to the commiting message

Are you sure you want to commit these changes?

- y: Yes
- n: No
- c: Change the commit message

Please enter your choice (y/n/c): y
Issue Number:  1
Issue Title:  Add the issue number at the end of the committing message
Is this issue related to the commit? (y/n): y
[main d266c2f] Add: the issue name to the commiting message (issue: #1)
 2 files changed, 27 insertions(+), 25 deletions(-)

And now you are ready to push your changes 🎉🎉.

Additional Resources

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages