zstd icon indicating copy to clipboard operation
zstd copied to clipboard

Automatic code formatting?

Open cgbur opened this issue 1 year ago • 3 comments

I tried searching on the issues page, but couldn't find anyone who mentioned it, so I figure I would.

Has it been considered to add an automatic code formatter and guidelines in the contributing and a formatter configuration to the repository? I know I have had problems in the past where I've had to disable my editor's auto-formatting and manually adjust code format when working in the repository. Perhaps something like clang-format or a suitable alternative? At this point, it would be a pretty massive git diff that would destroy the blame, so it may be too late if preservation is a priority.

This is what sparked my question, as a CI/CD checker would prevent it: https://github.com/facebook/zstd/pull/3917#discussion_r1503239971

Obviously, this project has done well without it, so "no" is a perfectly acceptable answer as well 🙂

cgbur avatar Feb 27 '24 00:02 cgbur

"Considering" is the right label. We are not against it, and clang-format is probably the way to go. But taking the time to decide a formatting convention and then apply it to the whole project, accept the blame history impact along the way, is a non-negligible investment, that has proven hard to prioritize so far.

Cyan4973 avatar Feb 27 '24 01:02 Cyan4973