search

RomanHotsiy / commitgpt

Automatically generate commit messages using ChatGPT
1.56k stars 91 forks source link

issue: the example in the README is wrong #39

Open thiswillbeyourgithub opened 8 months ago

thiswillbeyourgithub commented 8 months ago

Hi,

In the example in the readme you have : 

suggest 10 commit messages based on the following diff:
{{diff}}
commit messages should:
 - follow conventional commits
 - message format should be: <type>[scope]: <description>

examples:
 - fix(authentication): add password regex pattern
 - feat(storage): add new test cases

The format should be <type>(scope): <description> with parentheses instead of brackets.