Skip to content

Commit 33bf186

Browse files
committed
docs: improve clarity and conciseness of commit message templates
- Remove an empty line from the conventional_commit template - Rephrase example summary comments for clarity and conciseness - Condense explanatory notes about example comments Signed-off-by: Bo-Yi Wu <[email protected]>
1 parent 0d87ad8 commit 33bf186

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

prompt/templates/conventional_commit.tmpl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Here are the labels you can choose from:
1616
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
1717
- test: Adding missing tests or correcting existing tests
1818

19-
2019
THE FILE SUMMARIES:
2120

2221
{{ .summary_points }}

prompt/templates/summarize_file_diff.tmpl

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,17 @@ Readability is top priority. Write only the most important comments about the di
2525

2626
EXAMPLE SUMMARY COMMENTS:
2727

28-
- Raise the amount of returned recordings from `10` to `100`
29-
- Fix a typo in the github action name
30-
- Move the `octokit` initialization to a separate file
31-
- Add an OpenAI API for completions
32-
- Lower numeric tolerance for test files
28+
- Increase the number of returned recordings from 10 to 100
29+
- Correct a typo in the GitHub Action name
30+
- Relocate the octokit initialization to a separate file
31+
- Implement an OpenAI API endpoint for completions
32+
- Reduce the numeric tolerance in test files
3333
- Add 2 tests for the inclusive string split function
3434

35-
Most commits will have fewer comments than this example list.
36-
The last comment does not include the file names,
37-
because there were more than two relevant files in the hypothetical commit.
38-
Do not include parts of the example in your summary.
39-
It is given only as an example of appropriate comments.
35+
Most commits include fewer comments than those shown in the example.
36+
The final comment omits file names when more than one relevant file is modified.
37+
Avoid repeating example content verbatim in your summary.
38+
Use this example solely as a guide for effective, concise commenting.
4039

4140

4241
THE GIT DIFF TO BE SUMMARIZED:

0 commit comments

Comments
 (0)