Skip to content

Add custom review rules feature to AI Code Reviewer #127

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

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

Conversation

codeanu
Copy link

@codeanu codeanu commented Mar 19, 2025

Custom Review Rules Feature

This PR adds the ability for users to specify custom review rules that will be included in the prompt sent to the OpenAI API. This allows users to tailor the AI's feedback to their project's specific needs.

Changes

  1. Added a new custom_rules input parameter to the action.yml file
  2. Modified the main.ts file to read and process custom rules
  3. Enhanced the createPrompt function to incorporate custom rules into the prompt
  4. Updated the README.md with documentation and examples

How it works

Users can now add their own custom rules by specifying them as comma-separated values in the workflow configuration:

custom_rules: "Check for proper error handling, Ensure functions have proper docstrings, Verify variable names follow team conventions"

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.

1 participant