Task/add readme #12
Merged
Task/add readme #12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update config file to look for "OPENAI_API_KEY" instead of "openai_api_key" - Remove unnecessary error handling for .env file - Strip quotes from API key retrieved from config file The update to the config file is more consistent with the naming conventions of environment variables, and the removal of error handling for the .env file simplifies the code. Stripping the quotes from the retrieved API key ensures consistency and compatibility with other API key retrieval methods. Testing Done: - Manual testing done to ensure that API key is retrieved correctly with both config file and .env file methods.
This commit adds a script, add-openai-api-key.sh, that allows users to add their OpenAI API key to happycommit's config file. The script checks if the API key already exists in the config file and prompts the user to update it if necessary. Once the key is added, users can run happycommit's git commit-gpt command to generate commit messages using GPT-3. Instructions for use: - Run the add-openai-api-key.sh script (found in jackbackes/happycommit on Github) to add your OpenAI API key to happycommit's config file. - Once the API key is added, run the git commit-gpt command to generate commit messages using GPT-3. Remember to proofread your commit message before submitting!
This commit adds installation instructions for HappyCommit tool, powered by OpenAI's GPT-3.5 Turbo language model. The instructions include prerequisites, getting started on macOS system, and building from source. Users can now easily install HappyCommit using Homebrew and configure the OpenAI API key to use it. The usage section provides a brief guide on how to use HappyCommit instead of using the git commit command. A link to the GitHub repository for HappyCommit is provided in the contributing section for users to submit contributions, feature requests, or bug reports. By using HappyCommit, users can focus on writing great code while HappyCommit crafts the perfect commit messages, which makes for an enjoyable Git experience. HappyCommit is licensed under the Apache License 2.0.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.