From f4c356d10e8e0633d7c8de01379e9234487bf26e Mon Sep 17 00:00:00 2001 From: oech3 <79379754+oech3@users.noreply.github.com> Date: Sat, 13 Jun 2026 00:46:18 +0900 Subject: [PATCH] CONTRIBUTING.md: replace coreutils by grep --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 54c509d..4aa1755 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ Finally, feel free to join our [Discord](https://discord.gg/wQVJbvJ)! We have the following goals with our development: - **Compatible**: The utilities should be a drop-in replacement for the GNU - coreutils. + grep. - **Cross-platform**: All utilities should run on as many of the supported platforms as possible. - **Reliable**: The utilities should never unexpectedly fail. @@ -55,7 +55,7 @@ are some tips for writing good issues: reported. - Make sure to include all relevant information, such as: - Which version of uutils did you check? - - Which version of GNU coreutils are you comparing with? + - Which version of GNU grep are you comparing with? - What platform are you on? - Provide a way to reliably reproduce the issue. - Be as specific as possible! @@ -93,7 +93,7 @@ submit a patch! ### Don't `panic!` -The coreutils should be very reliable. This means that we should never `panic!`. +grep should be very reliable. This means that we should never `panic!`. Therefore, you should avoid using `.unwrap()` and `panic!`. Sometimes the use of `unreachable!` can be justified with a comment explaining why that code is unreachable. @@ -127,7 +127,7 @@ for a solution involving macros. Rust has many string-like types, and sometimes it's hard to choose the right one. It's tempting to use `str` (and `String`) for everything, but that is not always the right choice for uutils, because we need to support invalid UTF-8, -just like the GNU coreutils. For example, paths on Linux might not be valid +just like the GNU grep. For example, paths on Linux might not be valid UTF-8! Whenever we are dealing with paths, we should therefore stick with `OsStr` and `Path`. Make sure that you only convert to `str`/`String` if you know that something is always valid UTF-8. If you need more operations on