Contributing

PlaceOS adheres to the Contributor Covenent Code of Conduct.

Making Changes

Pull Request Flow

Open a pull request with your changes
Ensure the PR title is in the form of a conventional commit (see below)
Get CI to pass
Request a review from someone who has worked on the codebase

Commit Style

PlaceOS uses conventional commits.

Testing

Given you have the following dependencies...

It is simple to develop the service with docker.

With Docker

Run specs, tearing down the docker-compose environment upon completion.

$ ./test

Run specs on changes to Crystal files within the src and spec folders.

$ ./test --watch

Without Docker

To run tests

$ crystal spec

NOTE: The upstream dependencies specified in docker-compose.yml are required...

Compiling

$ shards build