Mirrors/rust-cookbook
2
0
Fork 0
mirror of https://github.com/rust-lang-nursery/rust-cookbook synced 2024-11-21 19:13:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Make the PR template a little less confusing

Browse source
This commit is contained in:
Michał Budzyński 2017-11-03 12:35:43 +01:00 committed by GitHub
parent f2ab6f8ff9
commit 7cd2b21881
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,6 +1,6 @@
fixes #ISSUE_ID
:tada: Hi and welcome! Please read the text below and remove it - Thank you! :smile: :tada:
:tada: Hi and welcome! Please read the text below and remove it - Thank you! :tada:
No worries if anything in these lists is unclear. Just submit the PR and ask away! :+1:
@ -10,9 +10,11 @@ No worries if anything in these lists is unclear. Just submit the PR and ask awa
- [ ] 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
- [ ] PR contains correct "fixes #ISSUE_ID" clause to autoclose the issue on PR merge
- if issue does not exist consider creating it or remove the clause
- [ ] non rendered items are in sorted order (links, reference, identifiers, Cargo.toml)
- [ ] links to docs.rs have wildcard version
- [ ] links to docs.rs have wildcard version `https://docs.rs/tar/*/tar/struct.Entry.html`
- [ ] example has standard [error handling](https://rust-lang-nursery.github.io/rust-cookbook/about.html#a-note-about-error-handling)
- [ ] code identifiers in description are in hyperlinked backticks
```markdown
[`Entry::unpack`]: https://docs.rs/tar/*/tar/struct.Entry.html#method.unpack
@ -20,4 +22,6 @@ No worries if anything in these lists is unclear. Just submit the PR and ask awa
### 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:
- [ ] 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:
Thank you for reading, you may now delete this text! Thank you! :smile: