Skip to content

Commit 72f388d

Browse files
committed
Add Review Guidelines page and link it in the nav
1 parent 746f8e1 commit 72f388d

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

content/reviews.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ project's `CONTRIBUTING.md` links here; the rules below apply to all of them.
2020
It is fine to look at permissively-licensed implementations
2121
([Apple's file_cmds](https://github.com/apple-oss-distributions/file_cmds/),
2222
[OpenBSD](https://github.com/openbsd/src/tree/master/bin)) and to read the GNU
23-
*manuals* and man pages just never the GNU *source*.
23+
*manuals* and man pages - just never the GNU *source*.
2424

2525
## What a reviewer expects before merging
2626

@@ -42,7 +42,18 @@ check these before requesting a review, your PR will move much faster.
4242
issue *before* writing the code, so effort isn't wasted on a change we can't
4343
merge.
4444
- **It follows GNU behavior** for options and output, verified against the GNU
45-
manual or output — never the GNU source.
45+
manual or output - never the GNU source.
46+
- **It does not regress performance.** Runtime should not get more than **3%**
47+
slower than the current `main`. Increased memory usage is acceptable when it is
48+
justified (e.g. it buys a meaningful speed-up or is needed for correctness).
49+
- **It does not regress binary size.** The compiled binary should not grow more
50+
than **3%** compared to the current `main`, unless the increase is justified by
51+
the change.
52+
- **New dependencies must be discussed and justified.** Adding a crate is not
53+
free - it affects build time, binary size, the audit surface, and licensing.
54+
Raise it first, explain why it's needed and why an existing dependency or a
55+
small amount of in-tree code won't do, and make sure its license is compatible
56+
(see Licensing in each project's `CONTRIBUTING.md`).
4657

4758
### Commit hygiene reviewers care about
4859

0 commit comments

Comments
 (0)