From 7cd2b218818d6926d7197ca3babb683e7e04a8e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Budzy=C5=84ski?= Date: Fri, 3 Nov 2017 12:35:43 +0100 Subject: [PATCH] Make the PR template a little less confusing --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6310cf2..bcb9ee4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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: