Skip to content

Commit 949437f

Browse files
committed
Add CONTRIBUTING.md pointing to the review guidelines
1 parent fac25e3 commit 949437f

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing to tar
2+
3+
Hi! Welcome to uutils/tar, and thanks for wanting to contribute!
4+
5+
This project follows the shared conventions of the [uutils](https://github.com/uutils)
6+
organization. Before opening a pull request, please read:
7+
8+
- Our **[Review Guidelines](https://uutils.github.io/reviews/)** — what we expect
9+
from a pull request and how reviews are carried out.
10+
- Our community's [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md), if present.
11+
12+
Finally, feel free to join our [Discord](https://discord.gg/wQVJbvJ)!
13+
14+
> [!WARNING]
15+
> uutils is original code and cannot contain any code from GNU or other
16+
> strongly-licensed (GPL/LGPL) implementations. We **cannot** accept changes
17+
> based on the GNU source code, and you **must not link** to it either. You may
18+
> look at permissively-licensed implementations (MIT/BSD) and read the GNU
19+
> *manuals* — never the GNU *source*.
20+
21+
## In short
22+
23+
- Discuss non-trivial changes in an issue **before** writing the code.
24+
- Keep pull requests **small, self-contained, and descriptively titled**
25+
(e.g. `tar: fix ...`).
26+
- Make sure CI passes: tests are green, `rustfmt` is satisfied, and there are
27+
no `clippy` warnings.
28+
- Add tests for new behavior; don't let coverage regress.
29+
- Write small, atomic commits annotated with the component you touched.
30+
31+
See the [Review Guidelines](https://uutils.github.io/reviews/) for the full
32+
details.

0 commit comments

Comments
 (0)