Getting Started
Get started by creating an account on the FirstMate console. You only need your company e-mail to create a free account.
Installation
Installing FirstMate only takes 1 minute.
1. Create a FirstMate account.
Sign up with your e-mail here to start a free trial.
2. Link Your Git Provider
You will be able to link your git provider following the steps in the platform (takes 2 clicks).
We currently support GitHub, Bitbucket, Azure DevOps and Gitlab.
3. Create a Pull Request
You are all set! 🎉
The easiest way of triggering FirstMate is to open a new pull request. FirstMate will analyse the PR and reply with an in depth review based on coding guidelines.
4. Optionally create a guideline repository.
To improve and customise the FirstMate agent, you can add natural language rules and code examples. Our agent processes these rules from a centralised guideline repository containing markdown files. This kind of repo brings all best-practices to 1 place, and support all git features meaning you can suggest and discuss new rules in pull requests on this repo. The guideline repo can also contain project & pipeline templates, this lowers the room for interpretation and allows developers and the FirstMate agent to take over the template code into their implementations. This repo can be basic, containing a couple of rules and best-practices in natural language in one file, or it can contain fully functional templates of how you envision all projects should operate per type of project.
For more information on how to create this repo, click here.
Creating a guideline repo is optional. FirstMate will use a default set of rules and best-practices when the guidelines repo is not found.