Skip to content

Commit

Permalink
Merge pull request #106 from firstmatecloud/vincentdecl-patch-3
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
vincentdecl authored Nov 7, 2024
2 parents 76084ea + 603c703 commit 5e9f000
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We’re excited to have you here! This repository gives you a hands-on experienc

- **🚀 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]((https://docs.firstmate.io/)).
- **⚙️ 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](https://docs.firstmate.io/).

### Upcoming Feature
- **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.
Expand All @@ -25,7 +25,7 @@ This demo repository is designed to show FirstMate in action. Follow these steps

2. **📝 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.

3. **👀 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](https://github.com/firstmatecloud/guidelines-repo). For more customization options, visit our [documentation](https://firstmate.cloud/docs).
3. **👀 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](https://github.com/firstmatecloud/guidelines-repo). For more customization options, visit our [documentation](https://docs.firstmate.io/).

4. **🚀 Start Using FirstMate in Your Own Environment**: Ready to bring FirstMate into your own projects? Visit our [website](https://firstmate.cloud) to onboard FirstMate in your organization on GitHub, Bitbucket, or Azure DevOps.

Expand All @@ -35,7 +35,7 @@ If you have any questions, feedback, or just want to chat with us about FirstMat

## Documentation

For more detailed instructions on installing, configuring, and using FirstMate, please visit our [documentation website]((https://docs.firstmate.io/)).
For more detailed instructions on installing, configuring, and using FirstMate, please visit our [documentation website](https://docs.firstmate.io/).

## License

Expand Down

0 comments on commit 5e9f000

Please sign in to comment.