search

tak-bro / aicommit2

A Reactive CLI that generates git commit messages with Ollama, ChatGPT, Gemini, Claude, Mistral and other AI
https://www.npmjs.com/package/aicommit2
MIT License
162 stars 12 forks source link

Add Code Review Functionality to aicommit2 #76

Open arkavo-com opened 2 months ago

arkavo-com commented 2 months ago

Feature request

I would like to propose adding a code review feature to aicommit2. This feature would allow users to leverage the integrated AI models to automatically review code changes before commits are finalized. The review process could analyze code quality, adherence to best practices, and even suggest improvements or highlight potential issues.

Why?

Currently, aicommit2 excels at generating commit messages using multiple AI models. However, code reviews are an essential part of the software development process to ensure quality and consistency. Integrating AI-driven code reviews directly within the CLI tool would enhance the overall development workflow by providing immediate feedback on code quality, potentially reducing the number of bugs and improving the maintainability of the codebase.

Alternatives

Some alternative solutions include using separate AI tools for code review or relying on manual code reviews through pull requests. However, these approaches can be time-consuming and less integrated with the current aicommit2 workflow.

Additional context

This feature could be implemented as an optional step that runs before the commit message generation. Users could configure the AI models to focus on specific aspects of the code, such as security, performance, or style. The feature could also be integrated into Git hooks, allowing automatic reviews for each commit.

tak-bro commented 2 months ago

Thank you for the suggestion. It’s an interesting idea, and I’ll consider it for future development. However, I can’t make any promises at this stage. Thanks again for your input!

tak-bro commented 2 months ago

Hello @arkavo-com I've just updated to version 2.1.0. This version includes a new code review feature. Please take a look at the link. This feature uses a large number of tokens, so it should be used with caution. This feature is still experimental and has many aspects that need to be refined. I'll keep this issue open for now.

arkavo-com commented 2 months ago

tested. works well with llama3.1! nice job.

I am wondering how best to integrate with my workflow... first thought... Post commit code review:

  1. run with a --watch option that checks git commits (ideally the developer would do a local git commit)
  2. on commit, run code review
  3. output code review to terminal, non-interactive (ideally the developer would run this on a second or third monitor)
tak-bro commented 2 months ago

That's an interesting feature... I'm not sure if it's appropriate to do a code review after commit. It might be better to perform a code review after git add is triggered. Also, this feature seems to be different from the original purpose of aicommt2, so I’m considering creating a new program for it.

arkavo-com commented 2 months ago

Agreed on both points.

The thought around after a commit was assuming this workflow:

  1. developer does a local git commit (no push to remote)
  2. aicommit2 (or new program) does a code review of the local commit
  3. if aicommit2 approves, developer does a push to remote

The local commit represents a unit of work that is ready for a code review, but not necessarily the complete feature or fix.

arkavo-com commented 2 months ago

thinking more... I think the end goal is "AI-Enhanced Git Workflow".

perhaps this is the new program.

BTW, I think the feature you added is efficient for this ticket.

arkavo-com commented 2 months ago

an update... I use this code review feature all the time now.. thank you!

tak-bro commented 2 months ago

Hi. I'm currently researching for watch mode development. As you said, once the git commit event occurs, I'm going to request a code review. This feature is very experimental, but it seems useful and interesting.