From 454c8459f29d45117134c99062784994e9d8a1b9 Mon Sep 17 00:00:00 2001 From: Leon Sautour Date: Mon, 20 Feb 2023 14:28:49 +0100 Subject: [PATCH] docs(contributing): specify the use of unsafe for optimization (#67) --- CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 783336dd..053fd1c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,13 @@ If you close an issue that you have "imported" to this fork, please make sure th # Contributing +## Implementation Guidelines + +### Use of unsafe for optimization purposes + +**Do not** use unsafe to achieve better performances. This is subject to change, [see.](https://github.com/tui-rs-revival/tui-rs-revival/discussions/66) +The only exception to this rule is if it's to fix **reproducible slowness.** + ## Building [cargo-make]: https://github.com/sagiegurari/cargo-make "cargo-make" @@ -31,8 +38,6 @@ Building the project should be as easy as running `cargo make build`. ## :hammer_and_wrench: Pull requests - - All contributions are obviously welcome. Please include as many details as possible in your PR description to help the reviewer (follow the provided template). Make sure to highlight changes which may need additional attention or you are uncertain about.