Skip to content

Woot ai 🀘 specs to code checker, it checks your specification and your code for correctness and completeness

License

Notifications You must be signed in to change notification settings

bemijonathan/Woot

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

🌟 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/[email protected]
   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 🀟 [email protected].

About

Woot ai 🀘 specs to code checker, it checks your specification and your code for correctness and completeness

Resources

License

Stars

Watchers

Forks

Packages

No packages published