Giters

Nutlope / aicommits

A CLI that writes your git commit messages for you with AI

Home Page:https://www.npmjs.com/package/aicommits

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Local Setup Guide for Development and Testing

HlexNC opened this issue · comments

commented

Feature request

Provide detailed instructions on setting up and running the aicommits project locally for development and testing purposes, without the need for global npm installation.

Why?

Currently, the only provided method for running aicommits is via global npm installation. This approach is suitable for end-users, but it's not ideal for developers who wish to contribute to the project or test it locally in a controlled environment.

A local setup guide would simplify the process for developers looking to contribute to the project, enabling them to iterate and test changes more effectively before submitting pull requests. This is especially useful for open-source projects where the contributors may range from beginners to experienced developers.

Moreover, having a clear, local setup guide helps maintain consistency in development environments, reducing the chances of inconsistencies and "it works on my machine" issues.

Alternatives

No response

Additional context

Including detailed instructions on prerequisites (required software and versions), environment setup, installation of dependencies, and execution commands in the project's README.md would be beneficial.

commented

I would like to add that I've already tried setting up the project locally by performing the following steps:

  • Cloning the repository with git clone.
  • Installing the dependencies with npm install.
  • Attempting to build the project with npm run build.
  • Trying to link the package locally with npm link.

While these are standard steps for many Node.js projects, I found that this approach didn't work for aicommits. A more detailed setup guide tailored to this project's specific needs would therefore be incredibly helpful. This will not only help me but also any other developers who want to contribute to this project in the future.

commented

I haven't verified this tutorial, but just wanted to kindly remind you that it may be helpful for you: at the bottom of the project's README there is a "Contributing" section which includes a link to the contribution guidelines.

commented

Thank you @eMUQI