Skip to content

Commit 64a1246

Browse files
authored
chore: remove HTML comments and inline guide (#15613)
### What does this PR try to resolve? The HTML comments in the PR template, after this repo migrated to GitHub merge queue, often show up in the merge commit message when people forgot to delete it. This PR removes those, as they are only important for people never look at the contributor guide. We keep one link to the guide though at the top of the template. It also moves the entire template out of HTML comments, so it is more obvious for maintainers to see what will be in the merge commit message. The “Additional information” paragraph is removed, as I observed it is seldom used. ### How to test and review this PR? Copy and paste the PR template into the PR description preview, and see if it satisfies your eyes.
2 parents 2744aa9 + a5a9efc commit 64a1246

File tree

1 file changed

+7
-31
lines changed

1 file changed

+7
-31
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,12 @@
1-
<!--
2-
Thanks for submitting a pull request 🎉! Here are some tips for you:
3-
4-
* If this is your first contribution, read "Cargo Contribution Guide" first:
5-
https://doc.crates.io/contrib/
6-
* Run `cargo fmt --all` to format your code changes.
7-
* Small commits and pull requests are always preferable and easy to review.
8-
* If your idea is large and needs feedback from the community, read how:
9-
https://doc.crates.io/contrib/process/#working-on-large-features
10-
* Cargo takes care of compatibility. Read our design principles:
11-
https://doc.crates.io/contrib/design.html
12-
* When changing help text of cargo commands, follow the steps to generate docs:
13-
https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages
14-
* If your PR is not finished, set it as "draft" PR or add "WIP" in its title.
15-
* It's ok to use the CI resources to test your PR, but please don't abuse them.
1+
_Thanks for the pull request 🎉!_
2+
_Please read the contribution guide: <https://doc.crates.io/contrib/>._
163

174
### What does this PR try to resolve?
185

19-
Explain the motivation behind this change.
20-
A clear overview along with an in-depth explanation are helpful.
21-
22-
You can use `Fixes #<issue number>` to associate this PR to an existing issue.
23-
24-
### How should we test and review this PR?
25-
26-
Demonstrate how you test this change and guide reviewers through your PR.
27-
With a smooth review process, a pull request usually gets reviewed quicker.
28-
29-
If you don't know how to write and run your tests, please read the guide:
30-
https://doc.crates.io/contrib/tests
6+
_Explain the motivation behind this change._
7+
_A clear overview along with an in-depth explanation are helpful._
318

32-
### Additional information
9+
### How to test and review this PR?
3310

34-
Other information you want to mention in this PR, such as prior arts,
35-
future extensions, an unresolved problem, or a TODO list.
36-
-->
11+
_Demonstrate how you test this change and guide reviewers through your PR._
12+
_With a smooth review process, a pull request usually gets reviewed quicker._

0 commit comments

Comments
 (0)