mirror of
https://github.com/rust-lang-nursery/rust-cookbook
synced 2024-11-22 03:23:05 +00:00
Create PULL_REQUEST_TEMPLATE.md
This commit is contained in:
parent
d233cab25d
commit
74a240c9b4
1 changed files with 22 additions and 0 deletions
22
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
22
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,22 @@
|
|||
fixes #ISSUE_ID
|
||||
|
||||
:tada: Hi and welcome! Please read the text below and remove it - Thank you! :smile: :tada:
|
||||
|
||||
|
||||
--------------------------
|
||||
### Things to check before submitting a PR
|
||||
|
||||
- [ ] the tests are passing locally with `cargo test`
|
||||
- [ ] cookbook renders correctly in `mdbook serve -o`
|
||||
- [ ] commits are squashed into one and rebased to latest master
|
||||
- [ ] PR contains correct "fixes #ISSUE_ID" clause to autoclose the issue once PR is merged
|
||||
- [ ] non rendered items are in sorted order (links, reference, identifiers, Cargo.toml)
|
||||
- [ ] links to docs.rs have wildcard version
|
||||
- [ ] code identifiers in description are in hyperlinked backticks
|
||||
```markdown
|
||||
[`Entry::unpack`]: https://docs.rs/tar/*/tar/struct.Entry.html#method.unpack
|
||||
```
|
||||
|
||||
### Things to do after submitting PR
|
||||
- [ ] check if CI is happy with your PR
|
||||
- [ ] drop a comment on https://github.com/rust-lang-nursery/rust-cookbook/issues/209 if you consent to repository being relicensed with [CC0 license](https://creativecommons.org/choose/zero/) :+1:
|
Loading…
Reference in a new issue