Skip to content

Commit 5084072

Browse files
committed
Auto merge of #10218 - weihanglo:pr-template, r=alexcrichton
The first version of pull request template ### What this PR tries to resolve? We're trying to extract information out off the head of contributors. Hope this help the review process more friendly for everyone. ### How to test and review this PR? Copy this template and paste to your GitHub Web UI to see if it renders well. ### Additional information Kubernetes community has one of the best guide of ["Best Practices for Faster Reviews"]. It describes tips for contributors tocreate a high quality PR. We might want to create our own one and include it in PR template in the future. In addition, I don't know how much time it take to update the changelog. I saw some projects let PR author write down the release note of the PR. This sounds helpful to take some burden off from maintainers, as well as let contributors feel more involved. Anyway, it's not in this PR but is good to discuss later. ["Best Practices for Faster Reviews"]: https://github.com/kubernetes/community/blob/9b38b270640009f28d7d8710f74d955e0c374cef/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
2 parents 3897749 + 3d9d52f commit 5084072

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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":
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.
16+
17+
### What does this PR try to resolve?
18+
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
31+
32+
### Additional information
33+
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+
-->

0 commit comments

Comments
 (0)