ai codereviewer

Peninjau Kode AI

Peninjau Kode AI adalah Tindakan GitHub yang memanfaatkan API GPT-4 OpenAI untuk memberikan masukan dan saran cerdas pada permintaan penarikan Anda. Alat canggih ini membantu meningkatkan kualitas kode dan menghemat waktu pengembang dengan mengotomatiskan proses peninjauan kode.

Fitur

• Meninjau permintaan penarikan menggunakan API GPT-4 OpenAI.
• Memberikan komentar dan saran cerdas untuk meningkatkan kode Anda.
• Memfilter file yang cocok dengan pola pengecualian yang ditentukan.
• Mudah diatur dan diintegrasikan ke dalam alur kerja GitHub Anda.

Pengaturan

1. Untuk menggunakan Tindakan GitHub ini, Anda memerlukan kunci API OpenAI. Jika Anda belum memilikinya, daftar untuk mendapatkan kunci API di OpenAI.

2. Tambahkan kunci API OpenAI sebagai Rahasia GitHub di repositori Anda dengan nama OPENAI_API_KEY . Anda dapat menemukan informasi lebih lanjut tentang Rahasia GitHub di sini.

3. Buat file .github/workflows/main.yml di repositori Anda dan tambahkan konten berikut:

 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. Ganti your-username dengan nama pengguna GitHub atau nama organisasi tempat repositori AI Code Reviewer berada.

5. Sesuaikan input exclude jika Anda ingin mengabaikan pola file tertentu agar tidak ditinjau.

6. Terapkan perubahan pada repositori Anda, dan Peninjau Kode AI akan mulai mengerjakan permintaan penarikan Anda di masa mendatang.

Cara Kerjanya

Tindakan GitHub Peninjau Kode AI mengambil perbedaan permintaan penarikan, memfilter file yang dikecualikan, dan mengirimkan potongan kode ke OpenAI API. Ini kemudian menghasilkan komentar ulasan berdasarkan respons AI dan menambahkannya ke permintaan penarikan.

Berkontribusi

Kontribusi dipersilahkan! Silakan mengirimkan masalah atau menarik permintaan untuk meningkatkan Tindakan GitHub Peninjau Kode AI.

Biarkan pengelola menghasilkan paket akhir ( yarn build & yarn package ).

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT. Lihat file LISENSI untuk informasi lebih lanjut.