Skip to content
This repository has been archived by the owner on Mar 6, 2024. It is now read-only.

Update triage prompt #218

Merged
merged 7 commits into from
Apr 20, 2023
Merged

Update triage prompt #218

merged 7 commits into from
Apr 20, 2023

Conversation

harjotgill
Copy link
Contributor

@harjotgill harjotgill commented Apr 20, 2023

Summary by OpenAI

Release Notes:

  • Documentation: README file updated to provide more detailed information about the GitHub Action and its usage.
  • Refactor: Options prompt updated to provide clear guidelines for triaging code changes based on their potential impact.
  • Refactor: Review prompt updated to clarify instructions for grouping related changes and provide more details about changesets.

"Code review made better,
With clearer prompts and docs to tether.
Bugs and vulnerabilities we'll sever,
Thanks to this PR's clever endeavor."

@github-actions
Copy link
Contributor

🤖 OpenAI

Pull Request Review

This pull request aims to improve the review process for code changes by updating the prompt message and providing additional guidance. The changes include updates to the README file, options prompt, and review prompt.

The README file updates provide more detailed information about the GitHub Action and its usage. However, there are some areas where further clarification would be helpful, such as explaining the importance of using the OpenAI API instead of ChatGPT session and providing examples of customizing prompts.

The changes to the options prompt provide clear guidelines for triaging code changes based on their potential impact. However, it might be useful to provide additional guidance on evaluating the potential impact of a diff and identifying potential bugs or security vulnerabilities.

The updates to the review prompt clarify the instructions for grouping related changes and provide more details about the changesets. These changes are minor and do not affect the logic or functionality of the code.

Overall, these changes should help improve the review process and ensure that all code changes are thoroughly evaluated before being merged.

File Summary
README.md Provides more detailed information about the GitHub Action and its usage. Further clarification is needed in some areas.
src/options.ts Updates the options prompt to provide clear guidelines for triaging code changes based on their potential impact. Additional guidance and examples could further enhance the clarity and effectiveness of the triage process.
src/review.ts Updates the review prompt to clarify the instructions for grouping related changes and provide more details about the changesets. These changes are minor and do not affect the logic or functionality of the code.

Chat with 🤖 OpenAI Bot (@openai)

  • Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
  • Invite the bot into a review comment chain by tagging @openai in a reply.

Code suggestions

  • The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
  • You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Files ignored due to filter (1)

Ignored files

  • dist/index.js

src/review.ts Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
harjotgill and others added 5 commits April 20, 2023 08:47
I added apiOrg option for ChatGPTAPI in case you need it to specify
which organisation to use when you have multiple one in your OpenAI
account

I added a `OPENAI_API_ORG` optionnal env variable.

cc @harjotgill
@harjotgill harjotgill enabled auto-merge (squash) April 20, 2023 15:55
@harjotgill harjotgill merged commit 0b7d342 into main Apr 20, 2023
@harjotgill harjotgill deleted the update_prompt branch April 20, 2023 15:55
shoyuf pushed a commit to maybeLab/openai-mr-reviewer-gltlab that referenced this pull request Jun 25, 2023
<!-- This is an auto-generated comment: release notes by openai -->
### Summary by OpenAI

Release Notes:

- Documentation: README file updated to provide more detailed
information about the GitHub Action and its usage.
- Refactor: Options prompt updated to provide clear guidelines for
triaging code changes based on their potential impact.
- Refactor: Review prompt updated to clarify instructions for grouping
related changes and provide more details about changesets.

> "Code review made better,  
> With clearer prompts and docs to tether.  
> Bugs and vulnerabilities we'll sever,  
> Thanks to this PR's clever endeavor."
<!-- end of auto-generated comment: release notes by openai -->

---------

Co-authored-by: Aurélien Schelcher <aurelien.schelcher@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants