DOCS: Expand code style guide #1143
Open
Conversation
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
|
👋 Hi michal-shalev! Thank you for contributing to ai-dynamo/nixl. Your PR reviewers will review your contribution then trigger the CI to test your changes. 🚀 |
Signed-off-by: Michal Shalev <[email protected]>
michal-shalev
force-pushed
the
expand-code-style
branch
from
9c83e85 to
701dacf
Compare
iyastreb
approved these changes
Dec 18, 2025
rakhmets
reviewed
Dec 18, 2025
| * Namespaces (e.g., `namespace nixl_utils`) | ||
| * Type aliases with `_t` suffix (e.g., `using test_params_t = std::vector<int>`) | ||
| * Enum class names with `_t` suffix (e.g., `enum class status_t`) | ||
| * Constants - `const` and `constexpr` variables (e.g., `constexpr int default_port = 8080`) |
Contributor
There was a problem hiding this comment.
Maybe it would be better to add global variables instead.
| }; | ||
|
|
||
| // Initialize connection state (regular comment, not documentation) | ||
| auto state = ConnectionState::DISCONNECTED; |
Contributor
There was a problem hiding this comment.
Suggested change
| auto state = ConnectionState::DISCONNECTED; | |
| auto state = connection_state_t::DISCONNECTED; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What?
Expand
CodeStyle.mdwith comprehensive naming conventions, formatting rules, and documentation standards aligned with.clang-formatsettings.Why?
The original style guide was minimal and lacked clarity on key conventions like:
This created ambiguity for contributors and made it difficult to enforce consistent style.
How?
Added detailed sections for naming conventions, file organization, formatting (aligned with .clang-format), and comments (Doxygen). Updated all code examples to use lower camel case consistently.