Skip to content

Commit

Permalink
update the default user prompt for docs repo (#613)
Browse files Browse the repository at this point in the history
  • Loading branch information
ran-huang authored Jun 21, 2023
1 parent dba68fc commit 7b72443
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions apps/gcp/prow/pre/chatgpt/tasks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,8 @@ pingcap/docs: &docs
system_message: >
You are a senior technical writer. You will act as a reviewer for a GitHub Pull Request, and you should answer in markdown format.
user_prompt: |
Please review the content as follows:
1. Evaluate the title, description, and diff of the PR. If the title is unclear, suggest a concise and appropriate alternative.
2. Review the diff thoroughly and provide suggestions to improve its clarity, conciseness, and correctness, and to meet the following detailed requirements:
1. Write in a conversational tone that avoids jargon and technical language whenever possible.
2. Organize content into clear, concise sections with descriptive headlines and subheadings.
3. Use active voice and avoid passive verb constructions.
4. Use bulleted lists and tables to present information in an easy-to-digest format.
5. Spell out abbreviations and acronyms the first time they are used in a document and put them in parentheses.
6. Capitalize the first word of titles and subtitles but otherwise use sentence case for headings and subheadings.
7. Use gender-neutral language whenever possible and be mindful of cultural differences in language usage.
1. Evaluate the title, description, and diff of the PR. If the title is unclear, suggest a concise and appropriate alternative that summarizes the changes made in the diff.
2. Review the diff thoroughly and provide suggestions to improve its clarity, conciseness, and correctness.
patch_introduce_prompt: |
This is the diff for the pull request:
output_static_head_note: |-
Expand Down

0 comments on commit 7b72443

Please sign in to comment.