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

Add Feature to Ignore Formatting and Update Instruction Prompt #39

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

Conversation

stekman08
Copy link

Summary:
This PR introduces the ability to ignore formatting while reviewing code. It also updates the instruction prompt to be more concise and informative. The instruction prompt has been iteratively refined using ChatGPT to ensure clarity.

Background:
The original instruction prompt lacked the option to ignore formatting and was less concise. Furthermore, many developers use .editorconfig files which may not align with the formatting suggestions provided by ChatGPT, leading to unnecessary feedback and clutter in the pull request. This feature aims to address these issues by making the review process more flexible and the instructions easier to understand.

Changes:

  • Added a feature that allows reviewers to ignore formatting

  • Updated the instruction prompt for better clarity

Impact:
This will make the review process more adaptable to different coding styles and guidelines. It will also allow for better alignment with existing .editorconfig setups, reducing unnecessary feedback and ensuring clearer, more focused reviews.

Testing:
Multiple iterations have been tested using ChatGPT to ensure the instruction prompt is clear and concise.

Request for Review:
I'd appreciate your thorough review and feedback on these changes to ensure that they meet the project's standards and fulfill its requirements.

@mbrown-dlb
Copy link

The ability to have a configurable prompt (as a task setting similar to the things like Api Key, OpenAI mode, and Azure OpenAPI Endpoint, etc) is needed. Components of the prompt that detail how to output the data would most likely need to be non-overridable as the code needs to be able to know how to process the output but instructions of what to look for as well as what not to look for would be amazing.

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