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

Use clang-tidy #54

Open
AntoineRondelet opened this issue Jun 18, 2021 · 0 comments
Open

Use clang-tidy #54

AntoineRondelet opened this issue Jun 18, 2021 · 0 comments

Comments

@AntoineRondelet
Copy link
Contributor

The code base has recently been formatted with clang-format using the same styling guide as the one in Zeth (see #48).

As a next step, it would be good to run clang-tidy on the code base to enforce best practices and catch potentially problematic code patterns. However, as opposed to clang-format which simply formats code, clang-tidy suggests code changes. As such, extra care needs to be allocated when using clang tidy. Rather than using the same config as in Zeth and run clang-tidy --fix (which could trigger an enormous amount of changes in the code, making the associated PR very painful to review.. effectively increasing risks of unexpected code behavior/bug), it is preferable to take an incremental approach and support a subset of checks from the Zeth clang-tidy config that doesn't shuffle the code too much.

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

1 participant