Debugging CI

Convetional commits

We use conventional commits and each MR should have a title structured as the following example:

type(scope): message

Even though the check will pass if you ommit (scope) the team will ask you to adhere to this policy so we maintain the quality of history.

Building and linting of dotnet code

In the process of automatic quality checking of code we run linting and building. While we accept building warnings (which we might remove at some point in the future), we won't accept code that is not linted properly.

When the check fails due to linting one should simply run the following command:

dotnet format StaffHub.sln

After that the tool will automatically lint the solutions and they can push the linted code which will then result in a green check mark on the check.

Building of docs

If one was changing the documentation settings or the content, on a MR will run a check if the mkdocs can build the site. If it fails there is an error and the check will fail.

To debug this the easiest is to locally run mkdocs and fix the issue.