mirror of
https://github.com/di-sukharev/opencommit.git
synced 2026-01-11 14:48:07 -05:00
26ebfb416d
* docs(CONTRIBUTING.md): update `TODO.md` reference (#435) Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com> * feat(engine): add support for MLX AI provider docs/engine: update documentation to include new engine providers * fix(mlx.ts): add repetition_penalty option to generateCommitMessage method for improved model behavior --------- Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com> Co-authored-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
1.5 KiB
1.5 KiB
Contribution Guidelines
Thanks for considering contributing to the project.
How to contribute
- Fork the project repository on GitHub.
- Clone your forked repository locally.
- Create a new branch for your changes.
- Make your changes and commit them with descriptive commit messages.
- Push your changes to your forked repository.
- Create a pull request from your branch to the
devbranch. Notmasterbranch, PR todevbranch, please.
Getting started
To get started, follow these steps:
- Clone the project repository locally.
- Install dependencies with
npm install. - Run the project with
npm run dev. - See issues or TODO.md to help the project.
Commit message guidelines
Use the library to generate commits, stage the files and run npm run dev :)
Reporting issues
If you encounter any issues while using the project, please report them on the GitHub issue tracker. When reporting issues, please include as much information as possible, such as steps to reproduce the issue, expected behavior, and actual behavior.
Contacts
If you have any questions about contributing to the project, please contact by creating an issue on the GitHub issue tracker.
License
By contributing to this project, you agree that your contributions will be licensed under the MIT license, as specified in the LICENSE file in the root of the project.