ã…¤
Introducing an open-source Comperai that helps with effective GitHub history management. It generates commit messages that adhere to commit style guidelines through ChatGPT. Whether you're an individual developer or part of a large team, following unified rules and guidelines can improve code consistency and readability, and enhance collaboration.
- To get started with the Comperai, visit the Comperai Introduction.
- To see examples of Comperai results, visit the Comperai Example. ã…¤
To view the complete documentation, visit the Comperai Docs page. ã…¤
Introducing the style guideline items followed by the Comperai.
There are three grammatical rules for commit types.
- Write only in lowercase.
- Write the commit type after an emoji.
- Add a space after the colon (:).
Summarize the tasks performed briefly. There are three grammatical rules for commit titles.
- Write within 50 characters.
- Use a bullet point format.
- Do not use periods or special characters.
Describe the tasks performed in as much detail as possible. There are two grammatical rules for commit bodies.
- Write within 72 characters per line.
- Explain what was changed and why.
✨ feat: add function to perform addition
- Implemented 'add' function that returns the sum of two input parameters
ã…¤
Step 1 - Clone and Install the Repository
Clone the repository, set up the environment variables, and then install the Comperai.
git clone https://github.com/atik-persei/comperai
cd comperai
echo 'GPT_KEY=<Your GPT API KEY>
GPT_MODEL=<Your GPT Model ID>
GPT_SYSTEM=<Your GPT System Message>
GPT_INPUT_LIMIT=<Your Input Limit Length>' > .env
docker build -t comperai .
docker run -d --name comperai comperai
ã…¤
Step 2 - Use the Comperai
Now, start using the Comperai.
https://<Server ip OR Your ip>
ã…¤
We are translating the documentation into multiple languages for user convenience. Currently, two languages are supported.