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

Use the description if the author hasn't added an assertion #3

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

seanparkross
Copy link
Collaborator

Use the description if the author hasn't added an assertion.

Also, just wanted to know if it's necessary in these github actions to make every function async? Haven't because no promises but see that getAssertion is async.

Copy link
Collaborator

@robertjdominguez robertjdominguez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, @seanparkross 🤙

Everything LGTM, but I have a thought: would it be worthwhile to iterate on this a bit and send the description to OpenAI?

Here's the prompt we're using; it's expecting an assertion of some kind, not a description. While it's "smart" enough to pick up on the context, we might get better results if we did something like this:

  1. In the event there isn't an assertion, parse the description.
  2. If there is a description, send that to OpenAI inside of a prompt that's something like this: Take this PR description from a lazy engineer and create a user-facing usability assertion for documentation: ${description}.
  3. Finally, use the generated assertion in the original prompt to test the assertion.

I'm only slightly kidding about the "lazy engineer" bit 🤷

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.

2 participants