We should agree upon a style guide

[anayini]

Noticed that we don't seem to have an official style guide that we adhere to. I think it would be nice if we could pick one as we could encode at least parts of it into linting rules and ideally wouldn't have to look for examples in other Swift projects.

[the-freshlord]

We have SwiftLint integrated into the project. But lint warnings or error won't showing on pull requests. Only on the build logs. I am currently working on an enhancement to the Package Builder project to include a reporting feature for SwiftLint on pull requests. Once I get that up and running, we could integrate Package Builder into the CI for this project, which can then report style issues on pull requests.

[helje5]

in the meantime, can you post instructions on how to run the linting locally and what the settings are (and maybe where they come from?)

[anayini]

On some projects I actually add a git precommit hook that runs swiftlint, which can prevent you from commiting with style violations. (I have the bad habit of sometimes just not looking at the generated warnings in XCode if the linter is only run as a script phase 😅 ) . Also helps if you are developing without XCode.

But I agree with @helje5 we should just add some instructions for the basic usage somewhere.