What is PR Intent Checker?
PR Intent Checker is a GitHub Action that utilizes an AI model via Azure OpenAI Service to analyze code changes in a Pull Request (PR) and compare them against requirements specified in a linked GitHub Issue, helping to identify potential "intent drift" early in the development cycle.
How to use PR Intent Checker?
To use PR Intent Checker, add a workflow file in your repository that triggers the action on PR events, configure necessary secrets for Azure OpenAI, and ensure that your PR description includes a link to the relevant issue.
Key features of PR Intent Checker?
- Automated analysis of PR code changes against issue requirements.
- Integration with Azure OpenAI for AI-driven evaluations.
- Detailed reporting of results and explanations directly on the PR.
Use cases of PR Intent Checker?
- Ensuring code changes in PRs align with project requirements.
- Early detection of discrepancies between code and issue specifications.
- Streamlining the review process by providing AI-generated insights.
FAQ from PR Intent Checker?
- What is required to set up PR Intent Checker?
You need to create a workflow file, configure Azure OpenAI secrets, and link issues in your PR descriptions.
- Can I customize the AI model used?
Yes, you can specify your Azure OpenAI model deployment in the configuration.
- How does the action report results?
The action posts a comment on the PR with the evaluation result and explanation.