Mirrors/rust-cookbook
2
0
Fork 0
mirror of https://github.com/rust-lang-nursery/rust-cookbook synced 2024-11-22 03:23:05 +00:00
Code Issues Projects Releases Packages Wiki Activity
rust-cookbook/.github/PULL_REQUEST_TEMPLATE.md
Jubilee 16a043b09a Update inclusive range syntax, fix script pathname, crate deps (#547) 
Fix docs directing developer to incorrect pathname for spellcheck.sh
Add note on the normal behavior of spellcheck.sh for clarity
Fix instances of inclusive range syntax to use '..=' style
Depend directly on percent-encoding instead of expecting re-exports
This commit compiles and tests correctly on rustc v1.37.0

link-checker found 452 failures before this commit
link-checker found 452 failures after this commit
no new errors were added by this commit
2019-09-19 11:04:37 -07:00

1.3 KiB
Raw Blame History

fixes #ISSUE_ID

🎉 Hi and welcome! Please read the text below and remove it - Thank you! 🎉

No worries if anything in these lists is unclear. Just submit the PR and ask away! 👍

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 on PR merge
    • if issue does not exist consider creating it or remove the clause
  • spell check runs without errors ./ci/spellcheck.sh
  • link check runs without errors link-checker ./book
  • non rendered items are in sorted order (links, reference, identifiers, Cargo.toml)
  • links to docs.rs have wildcard version https://docs.rs/tar/*/tar/struct.Entry.html
  • example has standard error handling
  • code identifiers in description are in hyperlinked backticks
[`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

Thank you for reading, you may now delete this text! Thank you! 😄