Add Scalafmt to the repository #22
Description
Background
As discussed with the team, we've decided to try out the scalafmt tool, but not as a mandatory check for now. The goal here is to try it out and collectively decide whether we like it or not.
Benefits, as written in the tool's documentation:
Focus on what matters. Spend more time discussing important issues in code review and less time on code style. Scalafmt formats code so that it looks consistent between people on your team.
Feature
Experiment with scalafmt and demonstrate its capabilities.
Proposed Solution
Since we don't want to integrate the scalafmt into a list of mandatory checks in the CICD pipeline, we need a solution that will demonstrate the tool / provide the formatting guidance.
One such solution could be to create a PR that would demonstrate the capabilities of the scalafmt and add it as an optional CI check (that can fail, see continue-on-error option from here: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idcontinue-on-error).