Skip to content

CONTRIBUTING.md: replace coreutils by grep #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oech3 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

CONTRIBUTING.md: replace coreutils by grep #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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!
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Loading