search

heyodai / magic-commit

Generate commit messages with OpenAI’s GPT.
1 stars 0 forks source link

Add an optional verbosity flag #29

Open heyodai opened 1 year ago

heyodai commented 1 year ago

magic-commit -v [number]

Options:

Level Description
1 extremely terse
2 concise
3 detailed (default)
4 comprehensive
5 exhaustive and nuanced detail with comprehensive depth and breadth

Inspired by ChatGPT-AutoExpert

heyodai commented 1 year ago

My experiments so far indicate that modifying the verbosity significantly reduces the output quality. This isn't too surprising since a good commit message should be fairly concise.

Committing my work to the branch in case we decide to revisit this later.

cc: @rahulmysore23

heyodai commented 1 year ago

Per conversation with @rahulmysore23, re-opening for further investigation. Maybe just a max_length flag?

heyodai commented 1 year ago

@rahulmysore23 - Following up on our conversation, look at the branch for this ticket.

If you look in /magic-commit/templates, I was experimenting with using different few-shot prompting based on the user's requested verbosity. For example, examples_verb_1.jinja gives the shortest possible commit messages.