Skip to content

Latest commit

 

History

History
56 lines (48 loc) · 1.85 KB

README.md

File metadata and controls

56 lines (48 loc) · 1.85 KB

🌟 Woot!! 🌟

AI-Powered PR Acceptance Criteria Checker 🤖

📖 Description

Woot!! is an innovative AI tool 🛠️ designed to streamline PR reviews by ensuring alignment with acceptance criteria. It's perfect for developers, project maintainers, and teams looking for efficient and accurate PR evaluations.

🚀 Key Features

  • Automatic Summarization: 📝 Uses NLP to extract main points from PR descriptions.
  • Key Changes Highlight: 🔍 Identifies significant code changes for focused reviews.

🛠️ Setup and Installation

Follow these steps to get Woot!! up and running in your project:

  1. Create a .yml file in .github/workflows.
  2. Add the Woot!! action to your workflow.
  3. Configure your GitHub Token, OpenAI Key, and other necessary details.

💡 How to Use

Integrate Woot!! into your GitHub Actions workflow for automated PR checks. Here's an example configuration: 

-  name: Woot ai !!
   uses: bemijonathan/Woot@0.1
   with:
      githubToken: ${{ secrets.GITHUB_TOKEN }}
      openAIKey: ${{ secrets.OPEN_AI_KEY }}
      jiraEmail: ${{ secrets.JIRA_EMAIL }}
      jiraApiKey: ${{ secrets.JIRA_API_KEY }}
      jiraHost: ${{ secrets.JIRA_HOST }}

🤝 Contributing

Contributions are welcome! 🙌 Check out our contributing guidelines for more information.

📜 License

This project is free to use as custom software or any part can be extended for monetary value

📞 Support

Need help? Contact me 🤟 bemijonathan@gmail.com.