Skip to content

Commit 06080a9

Browse files
committed
docs: add fuzz pointer, AI policy, playground link, and Ubuntu note
1 parent 0c21cb9 commit 06080a9

2 files changed

Lines changed: 19 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ parts for getting started:
3838
- [`docs`](https://github.com/uutils/coreutils/tree/main/docs/src): the documentation for the website
3939
- [`tests/uutests/`](https://github.com/uutils/coreutils/tree/main/tests/uutests/):
4040
Crate implementing the various functions to test uutils commands.
41+
- [`fuzz/`](https://github.com/uutils/coreutils/tree/main/fuzz/): The differential fuzzers.
4142

4243
Each utility is defined as a separate crate. The structure of each of these
4344
crates is as follows:
@@ -68,7 +69,8 @@ We have the following goals with our development:
6869
- **Performant**: Our utilities should be written in fast idiomatic Rust. We aim
6970
to match or exceed the performance of the GNU utilities.
7071
- **Well-tested**: We should have a lot of tests to be able to guarantee
71-
reliability and compatibility.
72+
reliability and compatibility. Code coverage should not regress; new
73+
behavior should come with tests that cover it.
7274

7375
## How to Help
7476

@@ -194,6 +196,16 @@ If you edit a piece of code, make sure to update any comments that need to
194196
change as a result. The only thing worse than having no comments is having
195197
outdated comments!
196198

199+
## AI policy
200+
201+
AI-assisted contributions are allowed, but the same standards apply as for
202+
any other patch. If you use an AI tool to help write a change, you are still
203+
responsible for it: you should understand every line you submit and be able
204+
to explain and justify the change in review. Keep patches small and focused
205+
so they are easy to review, and self-review the diff carefully before opening
206+
a pull request - reviewers are there to double-check a human's work, not an
207+
LLM's output.
208+
197209
## Git Etiquette
198210

199211
To ensure easy collaboration, we have guidelines for using Git and GitHub.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ uutils aims to work on as many platforms as possible, to be able to use the same
5252
utils on Linux, macOS, Windows and other platforms. This ensures, for example,
5353
that scripts can be easily transferred between platforms.
5454

55+
uutils coreutils ships by default on Ubuntu since version 25.10.
56+
5557
<div class="oranda-hide">
5658

5759
## Documentation
@@ -65,6 +67,10 @@ the [coreutils docs](https://github.com/uutils/uutils.github.io) repository.
6567

6668
Use [weblate/rust-coreutils](https://hosted.weblate.org/projects/rust-coreutils/) to translate the Rust coreutils into your language.
6769

70+
You can try the utilities in your browser through the
71+
[WebAssembly playground](https://uutils.github.io/playground/), without
72+
installing anything.
73+
6874
<!-- ANCHOR: build (this mark is needed for mdbook) -->
6975

7076
## Requirements

0 commit comments

Comments
 (0)