Skip to content

Commit 74b8c48

Browse files
committed
CONTRIBUTING.md: drop outdated hint, add policies and links
1 parent d830e84 commit 74b8c48

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ crates is as follows:
5151
We have separated repositories for crates that we maintain but also publish for
5252
use by others:
5353

54+
- [coreutils-i18n](https://github.com/uutils/coreutils-l10n)
5455
- [uutils-term-grid](https://github.com/uutils/uutils-term-grid)
5556
- [parse_datetime](https://github.com/uutils/parse_datetime)
5657

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

82+
- Make sure the bug is coreutils's one. Some utils e.g. `find` and `sed` belong to [different repositories](https://github.com/uutils).
8183
- 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).
8284
- Search through the existing issues to see whether it has already been
8385
reported.
@@ -123,7 +125,7 @@ submit a patch!
123125
### Don't `panic!`
124126

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

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

263-
**Tip:** For Windows, Microsoft provides some images (VMWare, Hyper-V,
264-
VirtualBox and Parallels) for development [on their official download page](https://developer.microsoft.com/windows/downloads/virtual-machines/).
265-
266265
## Improving the GNU compatibility
267266

268267
Please make sure you have installed

0 commit comments

Comments
 (0)