ai codereviewer

مراجع كود الذكاء الاصطناعي

AI Code Reviewer هو إجراء GitHub يستفيد من واجهة برمجة التطبيقات GPT-4 API الخاصة بـ OpenAI لتقديم تعليقات واقتراحات ذكية بشأن طلبات السحب الخاصة بك. تساعد هذه الأداة القوية على تحسين جودة التعليمات البرمجية وتوفر وقت المطورين من خلال أتمتة عملية مراجعة التعليمات البرمجية.

سمات

• مراجعات طلبات السحب باستخدام OpenAI's GPT-4 API.
• يقدم تعليقات واقتراحات ذكية لتحسين التعليمات البرمجية الخاصة بك.
• يقوم بتصفية الملفات التي تطابق أنماط الاستبعاد المحددة.
• من السهل الإعداد والاندماج في سير عمل GitHub.

يثبت

1. لاستخدام إجراء GitHub هذا، تحتاج إلى مفتاح OpenAI API. إذا لم يكن لديك واحد، قم بالتسجيل للحصول على مفتاح API في OpenAI.

2. أضف مفتاح OpenAI API باعتباره سر GitHub في مستودعك بالاسم OPENAI_API_KEY . يمكنك العثور على مزيد من المعلومات حول أسرار GitHub هنا.

3. قم بإنشاء ملف .github/workflows/main.yml في مستودعك وأضف المحتوى التالي:

 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. استبدل your-username باسم مستخدم GitHub أو اسم المؤسسة حيث يوجد مستودع AI Code Reviewer.

5. قم بتخصيص إدخال exclude إذا كنت تريد تجاهل أنماط ملفات معينة حتى لا تتم مراجعتها.

6. قم بإجراء التغييرات على المستودع الخاص بك، وسيبدأ AI Code Reviewer في العمل على طلبات السحب المستقبلية.

كيف يعمل

يسترد إجراء GitHub الخاص بـ AI Code Reviewer فرق طلب السحب، ويصفي الملفات المستبعدة، ويرسل مجموعات التعليمات البرمجية إلى OpenAI API. ثم يقوم بعد ذلك بإنشاء تعليقات المراجعة بناءً على استجابة الذكاء الاصطناعي وإضافتها إلى طلب السحب.

المساهمة

المساهمات هي موضع ترحيب! لا تتردد في إرسال المشكلات أو سحب الطلبات لتحسين إجراء GitHub لمراجع AI Code.

اسمح للمشرف بإنشاء الحزمة النهائية ( yarn build yarn package ).

رخصة

هذا المشروع مرخص بموجب ترخيص MIT. راجع ملف الترخيص لمزيد من المعلومات.