About The Project

Getting Started

Installation

1. Install the package:

   • npm

   npm install @lapstimef1/aicommit -g

   • yarn

   yarn add @lapstimef1/aicommit -g

   • pnpm

   pnpm i -g @lapstimef1/aicommit

2. Init your configuration:

       aicommit config -g emoji

   This will create your config file.

3. Set the keys of the config:

       aicommit config -s <key>=<value>

Available keys: | Keys | Type of value | Details | |---|---|---| | emoji | boolean | Specify if the msg need to start with an emoji | | scope | boolean | Specify if the msg need a scope : emoji type**(scope)**: description | | autoPush | boolean | Specify if the msg need to push automatically after the commit | | description | boolean | Specify if the msg need to have a description |

Usage

Install the package like the previous step says, then in your git project, add a file git add (file name), then do aicommit.

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL-v3.0 License. See LICENSE for more information.

Contact

Your Name - @lapstime_ - [email protected]

Project Link: https://github.com/LapsTimeOFF/aicommit