search

precice / PreCICE.jl

Julia language bindings for preCICE
GNU Lesser General Public License v3.0
11 stars 1 forks source link

Deploy a code formatter for the bindings #24

Closed IshaanDesai closed 2 years ago

IshaanDesai commented 2 years ago

Currently we do not have a formatter which is governing the code styling for the bindings. We should investigate which is the most standard format to write Julia code and accordingly standardize the code and also if possible deploy a formatting action which will check if code added in the future is properly formatted or not.

One option could be the JuliaFormatter which is also used in VS Code.

erikscheurer commented 2 years ago

There is a official style guide but no way to enforce it as it mainly refers to how to use functionality and not the formatting. The JuliaFormatter you mentioned already has included github actions for checking the format and for a periodic format pull request. We can also take a look at the guildelines for Julia base developers. Other than those I didn't find a general Format or Formatter that is used widely. I'm even a little surprised, because the biggest packages found on Juliahub don't use a formatter workflow.