Provide some code style for rust #499
Open
+141
−0
Conversation
This file contains 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
Deploying contributing-docs with
|
| Latest commit: |
860c757
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0a28b182.contributing-docs.pages.dev |
| Branch Preview URL: | https://rust-style.contributing-docs.pages.dev |
|
New Issues
|
coroiu
reviewed
Jan 8, 2025
|
|
||
| ## Discourage match | ||
|
|
||
| Rust often provide good alternatives to doing match on `Option`s and `Result`s. |
There was a problem hiding this comment.
nit(non-blocking): looks weird and works without the "s"
Suggested change
| Rust often provide good alternatives to doing match on `Option`s and `Result`s. | |
| Rust often provide good alternatives to doing match on `Option` and `Result`. |
|
|
||
| Some scenarios where `expect` are allowed are: | ||
|
|
||
| - Calling libraries that guarantee that the allowed inputs never results in Err or None. |
There was a problem hiding this comment.
Suggested change
| - Calling libraries that guarantee that the allowed inputs never results in Err or None. | |
| - Calling libraries that guarantee that the allowed inputs never results in `Err` or `None`. |
|
|
||
| ## Avoid panics | ||
|
|
||
| Panics are forbidden in the Bitwarden codebase outside of tests. Errors should be handled gracefully |
There was a problem hiding this comment.
Technically expect results in a panic, therefore panics are not forbidden, only unwrap is forbidden.
suggestion:
Suggested change
| Panics are forbidden in the Bitwarden codebase outside of tests. Errors should be handled gracefully | |
| Panics are highly discouraged in the Bitwarden codebase outside of tests. Errors should be handled gracefully |
| ### Options | ||
|
|
||
| We use `clippy` to enforce general guidelines for working with | ||
| [`Option`](https://doc.rust-lang.org/std/option/enum.Option.html)s. Generally reach for methods |
There was a problem hiding this comment.
nit(non-blocking): same here, works without the "s"
Suggested change
| [`Option`](https://doc.rust-lang.org/std/option/enum.Option.html)s. Generally reach for methods | |
| [`Option`](https://doc.rust-lang.org/std/option/enum.Option.html). Generally reach for methods |
|
|
||
| ### Results | ||
|
|
||
| When working on [`Result`](https://doc.rust-lang.org/std/result/enum.Result.html)s it might be |
There was a problem hiding this comment.
nit(non-blocking):
Suggested change
| When working on [`Result`](https://doc.rust-lang.org/std/result/enum.Result.html)s it might be | |
| When working with [`Result`](https://doc.rust-lang.org/std/result/enum.Result.html) it might be |
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.
📔 Objective
Write some code style guidelines for writing rust.
⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes