Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tools to auto-format code to match the style guide #20

Open
Odie opened this issue Mar 7, 2018 · 2 comments
Open

Add tools to auto-format code to match the style guide #20

Odie opened this issue Mar 7, 2018 · 2 comments

Comments

@Odie
Copy link
Contributor

Odie commented Mar 7, 2018

As mentioned in #18 (comment)

I think it will be very helpful to make use of
https://github.com/weavejester/cljfmt or
https://github.com/kkinnear/zprint
to help enforce the style guide.

It'd be even better to add a shared pre-commit git hook, to reformat changed files before they are committed. It might take a bit of effort to get the tools setup, but it'll be easy to keep the code style uniform.

It's just one less thing to have to actively think about when working on the project. =)

@plexus
Copy link
Member

plexus commented Mar 7, 2018

If multiple support this idea, and someone who has had good experience with one of these tools is willing to set this up, then and I'm willing to consider this. However I have to say that personally I don't like this approach at all.

I have seen linting or formatting in CI become a nuisance much more often than I found it to be helpful, and I prefer to put my energy in teaching people good habits than in fighting tools.

@Odie
Copy link
Contributor Author

Odie commented Mar 8, 2018

Okay. Not sure what kind of trouble you ran into in other projects. Just thought it will make contributing more straightforward for everyone. Both people who are working on and reviewing the code do not have to keep their eye on the style.

Let's keep the issue open for a bit to see if anybody else wants to chime in about this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants