Added title and description to /describe command prompt
#180
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It can sometimes be beneficial for the agent to read the original PR description (as written by the user) to have a better understanding of the context. The code diff alone is great to understand __what__ is happening in the PR, but from the description the agent can understand the __why__. We often use the description to describe the bug that prompted the fix, the requirement that lead to this feature, or even some form of design for the PR. All of these can give the agent better context to write a better description on its own.
|
I tried that at the beginning. When you do this naive implementation, the model tends to copy the initial PR title and description |
|
Hmm interesting. Maybe instead of calling these fields title/description we can use something like "original user description - only use as a non-obligarory reference if it fits the observed PR code". |
|
i will play a bit with the prompting tomorrow, and see how it goes |
|
see #188 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It can sometimes be beneficial for the agent to read the original PR description (as written by the user) to have a better understanding of the context. The code diff alone is great to understand what is happening in the PR, but from the description the agent can understand the why. We often use the description to describe the bug that prompted the fix, the requirement that lead to this feature, or even some form of design for the PR. All of these can give the agent better context to write a better description on its own.