[0031] Org-Wide Rust Style Guide #31
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
Include much of the details from eka's style guide directly in the EEP to be a bit more self-contained.
jonringer
approved these changes
Oct 8, 2025
Contributor
jonringer
left a comment
jonringer
left a comment
There was a problem hiding this comment.
I'm not really opinionated, and this looks reasonable.
|
|
||
| # Acknowledgements | ||
|
|
||
| Thanks to the original authors of the `STYLE_GUIDE.md` for establishing a strong foundation for this proposal. Special thanks to @jonringer for his ongoing efforts in eka-ci and in driving ekapkgs forward. |
Member
Author
|
one setting of the rustfmt config in particular that might warrant some further scrutiny is: Tried to strike a balance from the default |
The easiest way to enforce sorting is with LLMs, but without very explicit instructions, they get confused and produced mixed results on the order of various types. For that reason, we shall be very explicit about how to sort types to alleviate this ambiguity and hopefully ease automation.
jonringer
approved these changes
Oct 11, 2025
Comment on lines
+77
to
+78
| Types (`struct`, `enum`, and `type` aliases) must be sorted as a single, interlaced group, alphabetically by their identifier. | ||
|
|
Contributor
There was a problem hiding this comment.
what's next? fascism?
lol
Member
Author
There was a problem hiding this comment.
I mean in practice it's never going to be perfect, but it's just a helpful guideline to try to maintain some semblance of organization in large modules.
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.
rendered