Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added inline documentation and command line switches. #33

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

matracey
Copy link

@matracey matracey commented Jun 8, 2023

Description

Adds several features and improvements to the codebase, including inline documentation, command line switches, usage information and a print prompt option.

Changes Made

  • Added JSDoc comments for better code clarity and maintainability.
  • Added minimist for command-line argument parsing.
  • Added the ability to print the prompt without calling the API, which is helpful if you don't have OpenAI API access.
  • Added a new promptTemplate parameter to the index file, providing greater flexibility for customizing the prompt for ChatGPT.
  • Added an "amend" (-a) command line switch to generate commit messages for the most recent commit instead of the index.
  • Removed outdated notice from README and updated usage details.

These changes should make the codebase easier to understand and more versatile.

Screenshots (if appropriate)

N/A

Checklist

  • Code follows the style guide and best practices
  • Manual testing has been performed on all changes
  • Changes have been documented in the README file

Copy link
Owner

@RomanHotsiy RomanHotsiy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is amazing!

Thanks a lot for contribution! I'll merge/release it after a quick testing later this week.

@matracey
Copy link
Author

matracey commented Jul 3, 2023

Hey, wanted to follow up to see if you had a chance to test and review this? Would love to see this get merged into the main tool 😄

@BillChirico
Copy link

@RomanHotsiy Any update on a merge here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants