Skip to content

Commit a2a204e

Browse files
authored
docs: improve grammar, clarity, and consistency in documentation (#204)
- Correct typo "Bellow" to "Below" and improve sentence structure for clarity. - Capitalize "CODE PATCH TO BE REVIEWED" for consistency. - Fix grammatical errors and improve clarity in the conventional commit template. - Correct "less" to "fewer" in the example summary comments. - Fix grammatical error in the summarize file diff template. - Change "high level" to "high-level" for consistency. - Update character limit reminder from 50 to 60 characters. - Ensure translation instructions emphasize high-level translation and formatting integrity. Signed-off-by: Bo-Yi Wu <[email protected]>
1 parent e4b86ad commit a2a204e

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Bellow is the code patch, please help me do a brief code review if any bug risk, security vulnerabilities and improvement suggestion are welcome
1+
Below is the code patch. Please help me do a brief code review. Any bug risks, security vulnerabilities, and improvement suggestions are welcome.
22

3-
THE Code Patch TO BE Reviewed:
3+
THE CODE PATCH TO BE REVIEWED:
44

55
{{ .file_diffs }}

prompt/templates/conventional_commit.tmpl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
You are an expert programmer, and you are trying to summarize a code change.
22
You went over every file that was changed in it.
3-
For some of these files changes where too big and were omitted in the files diff summary.
3+
For some of these files, changes were too big and were omitted in the file's diff summary.
44
Determine the best label for the commit.
55

66
Here are the labels you can choose from:
77

88
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
9-
- chore: Updating libraries, copyrights or other repo setting, includes updating dependencies.
9+
- chore: Updating libraries, copyrights, or other repo settings, includes updating dependencies.
1010
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, GitHub Actions)
11-
- docs: Non-code changes, such as fixing typos or adding new documentation (example scopes: Markdown file)
12-
- feat: a commit of the type feat introduces a new feature to the codebase
11+
- docs: Non-code changes, such as fixing typos or adding new documentation (example scopes: Markdown files)
12+
- feat: A commit of the type feat introduces a new feature to the codebase
1313
- fix: A commit of the type fix patches a bug in your codebase
1414
- perf: A code change that improves performance
1515
- refactor: A code change that neither fixes a bug nor adds a feature
16-
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
16+
- 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

1919

prompt/templates/summarize_file_diff.tmpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ index aadf691..bfef603 100644
1010
This means that `lib/index.js` was modified in this commit. Note that this is only an example.
1111
Then there is a specifier of the lines that were modified.
1212
A line starting with `+` means it was added.
13-
A line that starting with `-` means that line was deleted.
13+
A line starting with `-` means that line was deleted.
1414
A line that starts with neither `+` nor `-` is code given for context and better understanding.
1515
It is not part of the diff.
1616
After the git diff of the first file, there will be an empty line, and then the git diff of the next file.
@@ -32,7 +32,7 @@ EXAMPLE SUMMARY COMMENTS:
3232
- Lower numeric tolerance for test files
3333
- Add 2 tests for the inclusive string split function
3434

35-
Most commits will have less comments than this examples list.
35+
Most commits will have fewer comments than this example list.
3636
The last comment does not include the file names,
3737
because there were more than two relevant files in the hypothetical commit.
3838
Do not include parts of the example in your summary.

prompt/templates/summarize_title.tmpl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
You are an expert programmer, and you are trying to title a pull request.
2-
You went over every file that was changed in it.
3-
For some of these files changes were too big and were omitted in the files diff summary.
2+
You reviewed every file that was changed in it.
3+
For some of these files, changes were too extensive and were omitted in the file's diff summary.
44
Please summarize the pull request into a single specific theme.
55
Write your response using the imperative tense following the kernel git commit style guide.
6-
Write a high level title.
6+
Write a high-level title.
77
Do not repeat the commit summaries or the file summaries.
88
Do not list individual changes in the title.
99

@@ -19,5 +19,5 @@ THE FILE SUMMARIES:
1919

2020
{{ .summary_points }}
2121

22-
Remember to write only one line, no more than 50 characters.
22+
Remember to write only one line, no more than 60 characters.
2323
THE PULL REQUEST TITLE:

prompt/templates/translation.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
You are a professional programmer and translator, and you are trying to translate a git commit message.
2-
You want to ensure that the translation is high level and in line with the programmer's consensus, taking care to keep the formatting intact.
2+
You want to ensure that the translation is high-level and in line with the programmer's consensus, taking care to keep the formatting intact.
33

44
Now, translate the following message into {{ .output_language }}.
55

0 commit comments

Comments
 (0)