Chore: update AI review prompt

[katspaugh]

The robot talks too much.

[github-actions]

Branch preview

⏳ Deploying a preview site...

[github-actions]

Code review by ChatGPT

[github-actions]

Certainly! To improve the code and make it more effective, consider the following refactoring suggestions:

1. Event Types:

   • If the decision to monitor only the opened event is confirmed, clearly document the reasoning. If additional events (reopened, synchronize) might be relevant, consider keeping them to ensure comprehensive monitoring of PR changes.

2. Prompt Refinement:

   • The provided prompt is too vague for an AI model to give specific feedback. Maintain the detailed guidelines you initially had, as they provide clear instructions for the AI's task. Here’s an improved version that incorporates the initial structure with clarity:

permissions:

on:
  pull_request:
    types: [opened, reopened, synchronize]

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: AI Code Review
        env:
          MODEL: gpt-4o
          PROMPT: |
            As a Senior AI Software Architect, review the code changes in this pull request with these guidelines:
            1. **Focus on Issues**: Identify logical errors, best practice violations, or improvement opportunities; limit feedback on unchanged code unless impacted by the pull request changes.
            2. **Actionable Suggestions**: Offer specific, applicable recommendations for refactoring or fixes, emphasizing DRY and SOLID principles.
            3. **Conciseness**: Deliver feedback succinctly, avoiding unnecessary commentary, with a limit of 260 characters per comment.
            4. **Avoid Praise**: Provide constructive criticism without commendation unless contextually necessary for understanding.
            5. **Enabling Simplicity**: Suggest simplifications to code structure and logic to avoid complexity in components and functions.

3. Modularization & Best Practices:

   • Break down large functions into smaller, more manageable ones, applying the Single Responsibility Principle. This makes the code easier to test and maintain.
   • Review variable and function names to ensure they are descriptive and convey intent clearly.

4. Documentation:

   • Enhance inline documentation to improve readability and maintainability of the code for future developers who might work on it.

5. Testing & Validation:

   • Ensure that any changes include updated tests if applicable. Adding unit tests or integrating to existing test frameworks could increase reliability.

These recommendations aim to enhance code clarity, maintainability, and alignment with software architecture principles.