Add Feature to Ignore Formatting and Update Instruction Prompt #39
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.
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.