We’re excited to have you here! This repository gives you a hands-on experience with FirstMate, showcasing how it can help your team enforce coding standards, improve code quality & security, and streamline pull request reviews.
FirstMate is an AI-powered code review tool designed to make it easy for teams to maintain coding standards and enhance code quality. By integrating directly with your repository, FirstMate automatically reviews every pull request, ensuring it aligns with your organization's guidelines and providing valuable, actionable feedback.
- 🚀 Automated Code Review: FirstMate reviews every pull request against your organization’s standards, highlighting any inconsistencies or areas for improvement.
- 🔧 Pipeline Feedback: Detects and provides feedback on issues that may impact pipeline stability, helping developers address potential failures before they occur.
- ⚙️ Customizable Guidelines: Tailor FirstMate to enforce your unique code quality and style guidelines, ensuring consistency across projects. FirstMate also includes a set of default guidelines that come out of the box—learn more in our documentation.
- Auto-Generated Guidelines: Soon, FirstMate will be able to auto-generate a custom guidelines repository for you by analyzing your git history. By reviewing patterns in previous pull requests, FirstMate will identify frequent issues and create tailored guidelines, saving your team time and ensuring a smooth setup.
- Feedback Based on Open Source Tools: Soon, FirstMate will use statis analyzers like Checkov to give you even more valuable insights.
- Documentation Drift: Soon, FirstMate will detect when important files are changed, to remind you to update the docs.
This demo repository is designed to show FirstMate in action. Follow these steps to explore its capabilities:
-
🔍 Check Out Existing Pull Requests: To see examples of FirstMate’s feedback, take a look at the open pull requests in this demo repository. This will give you a sense of the kinds of insights and recommendations FirstMate provides. This repo is linked to our guidelines repository, so FirstMate is checking these rules to give feedback.
-
📝 Create a Pull Request: Make a change to the code in this demo repository and open a new pull request. FirstMate will automatically review your code and provide feedback directly within the PR based on predefined guidelines.
-
👀 Explore the Guidelines (Optional): FirstMate uses a set of default guidelines to validate pull requests in this demo. If you're curious about the specifics, you can check out the guidelines repository here. For more customization options, visit our documentation.
-
🚀 Start Using FirstMate in Your Own Environment: Ready to bring FirstMate into your own projects? Visit our website to onboard FirstMate in your organization on GitHub, Bitbucket, or Azure DevOps.
If you have any questions, feedback, or just want to chat with us about FirstMate, feel free to reach out via our website. We’re here to help and would love to hear from you!
For more detailed instructions on installing, configuring, and using FirstMate, please visit our documentation website.
This repository is licensed under the MIT License. See the LICENSE file for more information.
Stay up-to-date with the latest news and updates by following us on LinkedIn.
Happy coding!
– The FirstMate Team