ci: settle on consistent style and add warnings for violation #4183
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I would like to propose we change the preferred type name style and then eventually enforce this in CI.
I propose we change from the most common style of
snake_case
for type names toPascalCase
, and enforcesnake_case
for namespaces. Once the changes are made we can promote this clang-tidy warning into an error.NOTE: functions and variables remain as
snake_case
The primary motivator of changing types from
snake_case
toPascalCase
is it allows variables and types to have separate style. Often it makes sense to name a variable similar to the type. e.g.vw::Example example;
vsvw::example example;
Additionally, requires enum values and macros be
UPPER_CASE
.See here for a report detailing changes required so we adhere to these checks:
https://gist.github.com/jackgerrits/c8da9db95457c372ad72c4fd72aff4b7#file-report-md
Resolution:
After discussion we will keep using the existing default of
snake_case
because there was opposition to change. Enforcing consistency will go ahead as planned.