# Developer Guide

This guide describes how developers can contribute to this project.

Requirements:

- [Visual Studio Code](https://code.visualstudio.com/)
  - [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
- [Docker](https://www.docker.com/)

Steps:

1. Fork and clone the project locally.
2. Open its folder on Visual Studio Code.
3. Click on the pop-up "Reopen in Container", or type F1 and search for this option.
4. Change the code.
5. Run the build: `make`
6. Submit a pull request.
7. Check the [workflow run status](https://github.com/dinaldoap/compass/actions).
8. Wait for the code review.