https://github.com/phylum-dev/rust-style-guidelines
Rust code style guidelines
https://github.com/phylum-dev/rust-style-guidelines
Last synced: 3 months ago
JSON representation
Rust code style guidelines
- Host: GitHub
- URL: https://github.com/phylum-dev/rust-style-guidelines
- Owner: phylum-dev
- License: mit
- Created: 2022-06-14T18:19:32.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-14T22:32:18.000Z (over 2 years ago)
- Last Synced: 2025-06-04T23:10:07.870Z (about 1 year ago)
- Size: 5.86 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Rust Style Guidelines
This project aims at providing a guideline for writing consistent Rust code, to
reduce review friction and help new developers.
This is not a complete collection of all Rust style guidelines. If there are any
style conflicts not clarified by this repository, please open an issue.
## Other resources
There are numerous other resources which focus on de-facto standards in the Rust
community. Unless otherwise specified, these common guidelines should be applied
to all Rust code.
Notable examples:
-
-
-
## Table of Contents
1. [Rustfmt](rustfmt.md)
2. [Clippy](clippy.md)
3. [Comments](comments.md)
4. [Imports](imports.md)
5. [Ordering](ordering.md)
6. [Naming](naming.md)
7. [Error Handling](error_handling.md)
8. [Macros](macros.md)
9. [Tests](tests.md)
10. [Enums](enums.md)
11. [Structs](structs.md)
12. [Control Flow](control_flow.md)
13. [Functions](functions.md)
14. [Visibility](visibility.md)
## Contributing
If you wish to contribute a new rule, please use the `SKELETON.md` as a
structural guideline.
## License
MIT - with complete text available in the [LICENSE][license] file.
[license]: https://github.com/phylum-dev/rust-style-guidelines/blob/master/LICENSE