Repository navigation
style: naming convention with kind and scope prefixes, checked by clang-tidy - #29
Merged
Merged
Conversation
…ng-tidy A name shows its kind (E enum, I interface, T template parameter, k constant, b boolean) and its scope (m_ member, s_ static, g_ global), so a review reads right without an IDE. docs/naming.md is the single page for contributors and engine users; cpp.md points to it; .clang-tidy enforces every rule with readability-identifier-naming except the boolean prefix. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JfRmXnowFEecvNmG9b9szy
XavierBeheydt
added a commit
that referenced
this pull request
Nov 9, 2026
Follows the naming convention of #29 (E prefix for enums). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JfRmXnowFEecvNmG9b9szy
XavierBeheydt
added a commit
that referenced
this pull request
Nov 9, 2026
ESeverity, ISink and TArgs for the enum, the interface and the template parameter pack; m_file and m_sink for private members (#29). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JfRmXnowFEecvNmG9b9szy
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
A name tells its kind and its scope, so a diff reads right without an IDE (a review on GitHub or on a phone):
Eenum,Iinterface,Ttype template parameter,kconstant,bboolean;m_private/protected member,s_static member,g_global;PascalCasetypes,camelCasefunctions and values,AETHER_macros,lower_casenamespaces.Files:
docs/naming.md(new): the table and how to read it, one page for contributors and for engine users reading the API..agents/instructions/style/cpp.md: points to it instead of its old two-rule line..clang-tidy:readability-identifier-namingenforces every rule except the booleanbprefix (clang-tidy cannot select by type), which is left to review. The lowercase fixed-size aliases (i32,u8,f32,usize) and a loneTtemplate parameter are allowed.Verification
dev(version.cpp, the core tests,types.hppthrough them).I, enum withoutE,file_,counterstatic member,globalCount,maxLights,BAD_MACRO, wrong-case functions, parameters, locals, namespace, template parameter...) and none of the good ones (EGood,ISinkOk,TValue,m_fileOk,m_bDirty,g_countOk,kMaxLightsOk).Follow-ups
EErrorCode,ESeverity,ISink,m_file,TArgs...).docs/development.md(docs: avoid exceptions in engine code, and why #28) will link todocs/naming.md.🤖 Generated with Claude Code
https://claude.ai/code/session_01JfRmXnowFEecvNmG9b9szy