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

Specify a standard version of clang-format #113

Open
wbernoudy opened this issue Sep 19, 2024 · 3 comments
Open

Specify a standard version of clang-format #113

wbernoudy opened this issue Sep 19, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested or further design needed

Comments

@wbernoudy
Copy link
Member

Since we expect the C++ code to be formatted with clang-format, but there are inconsistencies between different versions, we should specify the version one is expected to use when doing development.

@arcondello arcondello added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested or further design needed labels Sep 19, 2024
@arcondello
Copy link
Member

We do not currently enforce clang-formatted code. We could consider doing so as well.

@wbernoudy
Copy link
Member Author

Agreed! For now at least, it would be nice to just have a note in the readme.

@arcondello
Copy link
Member

arcondello commented Sep 25, 2024

I don't think this is easy.

The ecosystem as a whole doesn't have a lot of consensus.

For internal repos, I am reasonably comfortable enforcing a version. But for public repos like this, where we want to encourage contribution from users, I don't think it's reasonable to require folks to install a specific version of clang simply to make a PR against this repo.

We could format as part of CI, but that comes with its own issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested or further design needed
Projects
None yet
Development

No branches or pull requests

2 participants