Skip to content

Commit 7f77d57

Browse files
author
desyco
committed
Update Readme with FirstMate info.
1 parent 467fb18 commit 7f77d57

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
1-
# Azure AKS helm NodeJS guidelines
1+
# FirstMate Demo Repository
22

3+
Welcome to the demo repository for **FirstMate**! This repository is designed to give you a hands-on experience with FirstMate and showcase how it can streamline your coding guidelines and devops practices across your entire organization through pull requests.
4+
Welcome to **DEVOPS 2.0**
35

4-
You can run this repo using npm run start
6+
## About FirstMate
57

8+
**FirstMate** is a powerful tool that helps enforce and maintain coding standards and devops practices within your organization.
9+
By integrating directly with your repository’s workflow, FirstMate ensures that every pull request adheres to your organization’s predefined guidelines and practices.
10+
Whether you’re working with a small team or a large-scale enterprise, FirstMate helps maintain code quality and consistency across all your projects.
11+
12+
### Key Features
13+
14+
- **Automated Code Review**: Automatically checks every pull request for compliance with your standards.
15+
- **Customizable Rules**: Tailor the rules and guidelines to match your organization's specific needs.
16+
- **Comprehensive Reporting**: Provides detailed reports on guideline adherence and potential improvements.
17+
- **Seamless Integration**: Works with your existing Git workflows and tools, including GitHub, Azure Devops, Bitbucket, and more.
18+
19+
## Getting Started
20+
21+
To get started with the demo, follow these steps:
22+
23+
1. **Investigate guidelines**: The guidelines repository that is used to validate pull requests, can be found [here](https://github.com/firstmatecloud/guidelines-repo)
24+
25+
2. **Validate open pull requests**: Have a look at the [open pull requests](https://github.com/firstmatecloud/demo-microservice/pulls) in this demo repo
26+
27+
3. **Create a new pull request**: Make changes to the codebase and create a pull request and enjoy your first Review by FirstMate
28+
29+
4. **Get started on your environment**: Have a look on our [website](https://firstmate.cloud) to onboard FirstMate in your organisation on Bitbucket, Azure Devops or Github.
30+
31+
## Documentation
32+
33+
For more detailed instructions on installing, configuring, and using FirstMate, please visit our [documentation website](https://docs.firstmate.cloud).
34+
35+
## License
36+
37+
This repository is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
38+
39+
## Stay Connected
40+
41+
Stay up-to-date with the latest news and updates by following us on [LinkedIn](https://www.linkedin.com/company/firstmatecloud).

0 commit comments

Comments
 (0)