ai codereviewer

Revisor de código de IA

AI Code Reviewer es una acción de GitHub que aprovecha la API GPT-4 de OpenAI para proporcionar comentarios y sugerencias inteligentes sobre sus solicitudes de extracción. Esta poderosa herramienta ayuda a mejorar la calidad del código y ahorra tiempo a los desarrolladores al automatizar el proceso de revisión del código.

Características

• Revisa las solicitudes de extracción utilizando la API GPT-4 de OpenAI.
• Proporciona comentarios y sugerencias inteligentes para mejorar su código.
• Filtra archivos que coinciden con patrones de exclusión especificados.
• Fácil de configurar e integrar en su flujo de trabajo de GitHub.

Configuración

1. Para utilizar esta acción de GitHub, necesita una clave API de OpenAI. Si no tiene una, regístrese para obtener una clave API en OpenAI.

2. Agregue la clave API de OpenAI como secreto de GitHub en su repositorio con el nombre OPENAI_API_KEY . Puede encontrar más información sobre GitHub Secrets aquí.

3. Cree un archivo .github/workflows/main.yml en su repositorio y agregue el siguiente contenido:

 name : AI Code Reviewer

on :
  pull_request :
    types :
      - opened
      - synchronize
permissions : write-all
jobs :
  review :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout Repo
        uses : actions/checkout@v3

      - name : AI Code Reviewer
        uses : your-username/ai-code-reviewer@main
        with :
          GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
          OPENAI_API_KEY : ${{ secrets.OPENAI_API_KEY }}
          OPENAI_API_MODEL : " gpt-4 " # Optional: defaults to "gpt-4"
          exclude : " **/*.json, **/*.md " # Optional: exclude patterns separated by commas

4. Reemplace your-username con su nombre de usuario de GitHub o el nombre de la organización donde se encuentra el repositorio de AI Code Reviewer.

5. Personalice la entrada exclude si desea ignorar la revisión de ciertos patrones de archivos.

6. Confirme los cambios en su repositorio y AI Code Reviewer comenzará a trabajar en sus futuras solicitudes de extracción.

Cómo funciona

La acción de GitHub AI Code Reviewer recupera la diferencia de solicitud de extracción, filtra los archivos excluidos y envía fragmentos de código a la API de OpenAI. Luego genera comentarios de revisión basados ​​en la respuesta de la IA y los agrega a la solicitud de extracción.

Contribuyendo

¡Las contribuciones son bienvenidas! No dude en enviar problemas o solicitudes de extracción para mejorar la acción de GitHub del revisor de código AI.

Deje que el mantenedor genere el paquete final ( yarn build y yarn package ).

Licencia

Este proyecto está bajo la licencia MIT. Consulte el archivo de LICENCIA para obtener más información.