Add format workflow

[WhySoBad]

This pull request adds a github workflow which checks for correct code formatting.

I created a separate workflow file for the format check which is then run before the build job. This way it can be reused should there ever be another workflow which needs to run after the format check step.

[levnikmyskin]

Thank you very much for taking the time for this. I was thinking: should we also use pre commit? I can take care of adding this over the weekend

[WhySoBad]

I don't fully understand what you mean by pre-commit. Do you mean to run the formatter in a git hook before committing or some kind of github workflow?

[levnikmyskin]

Yes, a git hook. We can use https://pre-commit.com/

[WhySoBad]

Yeah, sounds good. Do you mind adding it yourself? I don't know much about git hooks and probably won't find the time tomorrow to implement it

[levnikmyskin]

Yeah will do it myself! Not in the next days probably, as I'm a little busy with personal stuff, but will try to not forget about this!

[levnikmyskin]

hey @WhySoBad , finally added the pre-commit stuff. You can follow the instructions on https://pre-commit.com/ to install it. Also added a few other things. Let me know if this works for you!

[WhySoBad]

Hi,
I'm wondering why you chose to rely on an external program to install the pre-commit hook. We could simply create a Makefile target which installs a shell script into .git/hooks/pre-commit which then runs the formatter.

I think not having to rely on a 3rd party would be beneficial as it does not require every collaborator to first install another program just to install the script which runs the formatter. If we keep the current implementation I fear most people will simply not use it as the barrier for entry is too high.

Edit:
To keep all the features which are available with the current implementation we could simply version control the generated shell script and then install this using a Makefile target

[levnikmyskin]

I get your point, fair concern. There was no particular reason other than I already use this at work, and it was really easy to setup.
But I get it, and I'm also down to making it simpler, also considering this is not a professional project, with a rather simple codebase. I'll look into it, and come back to you