diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..5eb460b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,3 @@ +Every PR must\ +describe what the changes are\ +and it's a haiku. diff --git a/Cargo.lock b/Cargo.lock index b38b9a3..fe25bb5 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,7 +4,7 @@ version = 3 [[package]] name = "coffee_break" -version = "1.0.0" +version = "2.1.1" dependencies = [ "syn", ] diff --git a/Cargo.toml b/Cargo.toml index 7a1db40..4b3fa82 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "coffee_break" -version = "1.0.0" +# Each version bump *must* continue the Fibonacci sequence, right to left +version = "2.1.1" authors = ["Radek Vít "] edition = "2021" rust-version = "1.63.0" @@ -21,7 +22,10 @@ ra-friendly = [] check-friendly = [] [dependencies] -syn = { version = "2.0.57", default-features = false, features = ["proc-macro", "parsing"] } +syn = { version = "2.0.57", default-features = false, features = [ + "proc-macro", + "parsing", +] } [package.metadata.docs.rs] all-features = true diff --git a/README.md b/README.md index 0871b7e..982321e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Coffee break is a 🔥 blazing 🚀 fast 🦀 Rust 🥵 library, by Rust developers for Rust developers. It is: - **Developer-friendly**: Lets you take a break while compiling your code. - **Eco-friendly**: The compiler is just taking a nap. We're not computing the Ackermann function just to slack off. -- **Language server-unfriendly**: `rust-analyzer` is now also taking a nap. +- **Language server-~~un~~friendly**: `rust-analyzer` has insomnia now. ## Overview ![XKCD compiling](https://imgs.xkcd.com/comics/compiling.png) @@ -52,6 +52,8 @@ fn work_stuff() { } ``` +You can still run `cargo check` and `cargo clippy` without having to wait. + ## Notes The author doesn't drink coffee, but still enjoys taking a break. @@ -59,6 +61,7 @@ The author doesn't drink coffee, but still enjoys taking a break. Before contributing to this project, consider taking a coffee break first. PRs are welcome. +The first paragraph of any PR message must be a haiku describing the changes. Please follow the [community guidelines](https://www.rust-lang.org/policies/code-of-conduct). diff --git a/src/lib.rs b/src/lib.rs index ca2afee..b89c2de 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -14,10 +14,8 @@ use syn::{parse::Parse, Error}; /// ``` /// use coffee_break::coffee_break; /// -/// fn main() { -/// // Take a break while compiling this -/// coffee_break!(60 seconds); -/// } +/// // Take a break while running `cargo build` +/// coffee_break!(60 seconds); /// ``` /// #[proc_macro]