The first version of pull request template #10218
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <!-- | ||
| Thanks for submitting a pull request 🎉! Here are some tips for you: | ||
|
|
||
| * If this is your first contribution, read "Cargo Contribution Guide": | ||
| https://doc.crates.io/contrib/ | ||
| * Run `cargo fmt --all` to format your code changes. | ||
| * Small commits and pull requests are always preferable and easy to review. | ||
| * If your idea is large and needs feedback from the community, read how: | ||
| https://doc.crates.io/contrib/process/#working-on-large-features | ||
| * Cargo takes care of compatibility. Read our design principles: | ||
| https://doc.crates.io/contrib/design.html | ||
| * When changing help text of cargo commands, follow the steps to generate docs: | ||
| https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages | ||
| * If your PR is not finished, set it as "draft" PR or add "WIP" in its title. | ||
| * It's ok to use the CI resources to test your PR, but please don't abuse them. | ||
|
|
||
| ### What does this PR try to resolve? | ||
|
|
||
| Explain the motivation behind this change. | ||
| A clear overview along with an in-depth explanation are helpful. | ||
|
|
||
| You can use `Fixes #<issue number>` to associate this PR to an existing issue. | ||
|
There was a problem hiding this comment. Another command that is probably most commonly used for me is close#. Would you like to add more? That's advice, of course. |
||
|
|
||
| ### How should we test and review this PR? | ||
|
|
||
| Demonstrate how you test this change and guide reviewers through your PR. | ||
| With a smooth review process, a pull request usually gets reviewed quicker. | ||
|
|
||
| If you don't know how to write and run your tests, please read the guide: | ||
| https://doc.crates.io/contrib/tests | ||
|
|
||
| ### Additional information | ||
|
|
||
| Other information you want to mention in this PR, such as prior arts, | ||
| future extensions, an unresolved problem, or a TODO list. | ||
| --> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To add a sentence：
If your idea is large and needs feedback from the community, you are advised to release an issue for discussion first, read how:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds great! Though I am afraid that the template goes too lengthy and people eventually delete it anyway.