Formatting requirements/guidelines?

[vatsal-j]

JuliaFormatter.jl seems to be the main formatting tool for the language and what the Julia extension for VS Code uses. I've been finding the latter has some opinions on the formatting of the code, at least with the default settings. In small files I've been letting it format the entire file because I think it make it more readable, but the lack of a formatting guideline or tool means we don't have consistent formatting across the code base. We should think about rectifying that. That could be as little as a snippet in the contributing guidelines about using JuliaFormatter, or as much as a github action or pre-commit hook that runs. @pgbrodrick Thoughts?

[pgbrodrick]

Seems reasonable to use the JuliaFormatter - looks like it's just enforcing Julia Style conventions. I'd prefer if we go this route to include a GH Action, so that contributors don't need to be responsible for knowing how to do this. We should also, as a separate PR, format the full repo prior to instantiation.

[vatsal-j]

Looks like the Github actions will only add code suggestions for formatting in PRs or create new PRs to fix the format. To have it automatically format, we can use a pre-commit hook.