Skip to content

Commit 9b2a163

Browse files
committed
Auto merge of #3458 - JohnTitor:fix-contributing, r=JohnTitor
Update docs for contributors
2 parents b4686c6 + ab0c1df commit 9b2a163

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
Thanks for considering submitting a PR!
22

3+
We have the [contribution guide](https://github.com/rust-lang/libc/blob/main/CONTRIBUTING.md). Please read it if you're new here!
4+
35
Here's a checklist for things that will be checked during review or continuous integration.
46

5-
- \[ ] Edit corresponding file(s) under `libc-test/semver` when you add/remove item(s)
6-
- \[ ] Your PR doesn't contain any *unstable* values like `*LAST` or `*MAX` (see [#3131](https://github.com/rust-lang/libc/issues/3131))
7-
- \[ ] If your PR increments version number, it must not contain any other changes
8-
- \[ ] `rustc ci/style.rs && ./style src`
7+
- \[ ] Edit corresponding file(s) under `libc-test/semver` when you add/remove item(s), e.g. edit `linux.txt` if you add an item to `src/unix/linux_like/linux/mod.rs`
8+
- \[ ] Your PR doesn't contain any private or *unstable* values like `*LAST` or `*MAX` (see [#3131](https://github.com/rust-lang/libc/issues/3131))
9+
- \[ ] If your PR has a breaking change, please clarify it
10+
- \[ ] If your PR increments version number, it must NOT contain any other changes (otherwise a release could be delayed)
11+
- \[ ] Make sure `ci/style.sh` passes
912
- \[ ] `cd libc-test && cargo test`
1013
- (this might fail on your env due to environment difference between your env and CI. Ignore failures if you are not sure)
1114

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ We have two automated tests running on [GitHub Actions](https://github.com/rust-
5454
- `cd libc-test && cargo test`
5555
- Use the `skip_*()` functions in `build.rs` if you really need a workaround.
5656
2. Style checker
57-
- `rustc ci/style.rs && ./style src`
57+
- [`sh ci/style.sh`](https://github.com/rust-lang/libc/blob/main/ci/style.sh)
5858

5959
## Breaking change policy
6060

0 commit comments

Comments
 (0)