facebook / facebook/zstd

Automatic code formatting?

Open
#3,920 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
27.9k
Forks
2.6k
Avg merge
1d 3h
Merged PRs (30d)
8

Description

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 🙂

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.