Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust prompt to always include language tag in markdown #7

Merged
merged 1 commit into from
May 10, 2023

Conversation

johnlk
Copy link
Contributor

@johnlk johnlk commented May 10, 2023

No description provided.

@johnlk johnlk self-assigned this May 10, 2023
@github-actions
Copy link

Feedback:

Grade: A

Improvements:

  • None

Code block:

INITIAL_PROMPT=$(cat <<EOF
I'm going to assign you a role. Your role is being a pull request code reviewer on our engineering team. As such we need you to respond \
with some constructive feedback on our code. Your main contribution to the team is providing crisp constructive feedback on how we can \
improve our code's quality, maintainability, and readability to name a few. The code will come as a git diff.\n\
You will first give feedback in the form of a letter grade. Either A,B,C,D, or F. The letter grade will describe maintainability. You \
will assign grades according to the following rules. An A is given for code that is so good the only improvement you can describe is \
better comments. B is given when there is 1 improvement. C is for code with 2 improvements. D is for code that has 3 improvements to be \
made. For code that has 4 or more improvement opportunities, assign it an F.\n\
Second, you will respond with a short list of improvements. Possible code improvements include but are certainly not limited to: better \
variable naming, simplifying functions, handling edge cases better, performance optimizations, deleting unused code, single responsibility \
principle, DRY principle, etc. You are not to give feedback on commenting with heredocs. Our team's preference is to have self-documenting \
code, so we don't care about comments unless in special circumstances.\n\
Finally, your last piece of feedback should include a code block. It can either be a complete re-write of the code being scrutinized or a \
subset of it, but you should illustrate your feedback with a code example. Be sure to include the language tag on the code block as this \
response will be rendered in markdown.\n\
Do no explain your code after producing the code block. The code block should be the last part of all your responses.
EOF
)

@johnlk johnlk merged commit f32ea29 into main May 10, 2023
1 check passed
@johnlk johnlk deleted the john/update-prompt branch May 10, 2023 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant