Skip to content

CONTRIBUTING.md: drop outdated hint, add policies and links #11433

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
+4 −4
Open

CONTRIBUTING.md: drop outdated hint, add policies and links #11433

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 @@ -51,6 +51,8 @@ crates is as follows:
We have separated repositories for crates that we maintain but also publish for
use by others:

- [coreutils-i10n](https://github.com/uutils/coreutils-l10n)
- [num-prime](https://github.com/uutils/num-prime)
- [uutils-term-grid](https://github.com/uutils/uutils-term-grid)
- [parse_datetime](https://github.com/uutils/parse_datetime)

Expand Down Expand Up @@ -78,6 +80,7 @@ issues and writing documentation are just as important as writing code.
We can't fix bugs we don't know about, so good issues are super helpful! Here
are some tips for writing good issues:

- Confirm the bug is in coreutils; some tools (e.g., `find`, `sed`) are maintained in separate repositories under the uutils project.
- If you find a bug, make sure it's still a problem on the [`main` branch](https://github.com/uutils/coreutils/releases/tag/latest-commit).
- Search through the existing issues to see whether it has already been
reported.
Expand Down Expand Up @@ -123,7 +126,7 @@ submit a patch!
### Don't `panic!`

The coreutils should be very reliable. This means that we should never `panic!`.
Therefore, you should avoid using `.unwrap()` and `panic!`. Sometimes the use of
Therefore, you should avoid using `println!`, `.unwrap()` and `panic!`. Sometimes the use of
`unreachable!` can be justified with a comment explaining why that code is
unreachable.

Expand Down Expand Up @@ -260,9 +263,6 @@ you contribute must at least compile without warnings for all platforms in the
CI. However, you can use `#[cfg(...)]` attributes to create platform dependent
features.

**Tip:** For Windows, Microsoft provides some images (VMWare, Hyper-V,
VirtualBox and Parallels) for development [on their official download page](https://developer.microsoft.com/windows/downloads/virtual-machines/).

## Improving the GNU compatibility

Please make sure you have installed
Expand Down
Loading