Skip to content

Commit

Permalink
docs: update commit message guidelines
Browse files Browse the repository at this point in the history
- remove redundant line length restriction
- add markdown list usage for multiple changes in commit body
- clarify instructions on commit message structure
  • Loading branch information
liblaf committed Nov 29, 2024
1 parent f1fbca3 commit de62d93
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/llm_cli/assets/prompts/commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ The commit message should be structured as follows:
[optional footer(s)]
```

- lines must not be longer than 74 characters
- use a markdown list for the optional body if it contains multiple items
- choose only 1 type from the type-to-description below:
- feat: introduce new features
- fix: fix a bug
Expand All @@ -57,6 +55,8 @@ The commit message should be structured as follows:
- ci: changes to our CI configuration files and scripts
- chore: other changes that don't modify src or test file
- build: make architectural changes
- don't over explain and write your commit message inside <Answer> tags and include no other text.
- don't over explain and write your commit message inside <Answer> tags and include no other text
- if the commit involves multiple changes, use markdown unordered list in the commit body to list them clearly
- lines must not be longer than 74 characters

Now, based on the provided code diff and any additional context, create a concise but meaningful commit message following the instructions above.

0 comments on commit de62d93

Please sign in to comment.