diff --git a/.clang-tidy b/.clang-tidy index 873e6d63e..d6c18e64c 100644 --- a/.clang-tidy +++ b/.clang-tidy @@ -10,13 +10,16 @@ CheckOptions: - { key: readability-identifier-naming.StructCase, value: CamelCase } - { key: readability-identifier-naming.VariableCase, value: lower_case} - { key: readability-identifier-naming.LocalVariableCase, value: lower_case} - - { key: readability-identifier-naming.FunctionCase, value: camelBack} + - { key: readability-identifier-naming.FunctionCase, value: lower_case} - { key: readability-identifier-naming.FunctionIgnoredRegexp, value: '^to_json$|^from_json$'} - - { key: readability-identifier-naming.ClassMethodCase, value: camelBack} + - { key: readability-identifier-naming.ClassMethodCase, value: lower_case} - { key: readability-identifier-naming.ClassMethodIgnoredRegexp, value: '^to_json$|^from_json$'} - { key: readability-identifier-naming.ParameterCase, value: lower_case} - { key: readability-identifier-naming.ParameterIgnoredRegexp, value: '^j$'} + - { key: readability-identifier-naming.EnumCase, value: CamelCase} + - { key: readability-identifier-naming.EnumConstantCase, value: CamelCase} - { key: readability-identifier-naming.ConstantParameterCase, value: lower_case} + - { key: readability-identifier-naming.ConstexprVariableCase,, value: UPPER_CASE} - { key: readability-identifier-naming.ConstantParameterIgnoredRegexp, value: lower_case} - { key: readability-identifier-naming.TypedefCase, value: CamelCase} - { key: misc-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic, value: 'true'} diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 537a0f315..bdaf1e006 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,7 +17,7 @@ Please edit this text to include a summary of the change and which issue is fixe - [ ] code naming scheme follows the convention: Style | Elements - ------------ | --------------------- - `PascalCase` | classes, namespaces - `camelCase` | functions - `snake_case` | variables + ------------ | -------------------------- + `CamelCase` | classes, namespaces, enums + `lower_case` | functions, variables, enum constants + `UPPER_CASE` | constexpr variables diff --git a/docs/_docs/install.md b/docs/_docs/install.md index cf01d1381..408ea7205 100644 --- a/docs/_docs/install.md +++ b/docs/_docs/install.md @@ -199,11 +199,10 @@ the style configuration file [`.clang-format`](https://github.com/mlund/faunus/b Also, adhere to the following naming conventions: Style | Elements ------------- | ------------------------- -`CamelCase` | classes, namespaces -`camelBack` | functions -`snake_case` | variables - +------------ | -------------------------- +`CamelCase` | classes, namespaces, enums +`lower_case` | functions, variables, enum constants +`UPPER_CASE` | constexpr variable ## Creating a conda package (development usage)