Guidelines Repo

This repo contains company-wide guidelines to be followed by all developers and enforced by the FirstMate application.

FirstMate

This repo can be used as an example/template repo for all your developers. Besides that, the FirstMate solution will use these guidelines to review all your pull request and make sure your code stays in line with the rules written here.

For more information take a look at the FirstMate website

For more technical information, we like to refer to the FirstMate docs

Repo structure

A company guideline repo should follow this structure:

• GUIDELINES.md
• Category 1
  • GUIDELINES.md
  • Subcategory 1
    • template
    • GUIDELINES.md
  • Subcategory 2
    • template
    • GUIDELINES.md
• Category 2
  • Subcategory 1
    • template
    • GUIDELINES.md

As you can see in this repo we use the structure

• GUIDELINES.md
• Microservices
  • GUIDELINES.md
  • nodejs
    • template
    • GUIDELINES.md
  • python
    • template
    • GUIDELINES.md
• infra
  • terragrunt
    • template
    • GUIDELINES.md
• environments
  • charts
    • template
    • GUIDELINES.md