milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Contributing: add instructions on wildcards in import statements

This commit is contained in:
Jose Storopoli 2024-06-21 17:39:18 +00:00
parent 9ba29b384e
commit 9ffa01f5ed
No known key found for this signature in database
GPG Key ID: 29E00111DE172C28
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -221,7 +221,6 @@ We use the following style for import statements, see
(https://github.com/rust-bitcoin/rust-bitcoin/discussions/2088) for the discussion that led to this. (https://github.com/rust-bitcoin/rust-bitcoin/discussions/2088) for the discussion that led to this.
```rust ```rust
// Modules first, as they are part of the project's structure. // Modules first, as they are part of the project's structure.
pub mod aa_this; pub mod aa_this;
mod bb_private; mod bb_private;
@ -237,6 +236,24 @@ pub use {
crate::aa_aa_this, crate::aa_aa_this,
crate::bb_bb::That, crate::bb_bb::That,
} }
// Avoid wildcard imports, except for 3 rules:
// Rule 1 - test modules.
#[cfg(test)]
mod tests {
use super::*; // OK
}
// Rule 2 - enum variants.
use LockTime::*; // OK
// Rule 3 - opcodes.
use opcodes::all::*; // OK
// Finally here is an example where we don't allow wildcard imports:
use crate::prelude::*; // *NOT* OK
use crate::prelude::{DisplayHex, String, Vec} // OK
``` ```
#### Return `Self` #### Return `Self`