Skip to content

Commit 452b7ad

Browse files
adpaco-awstedinski
authored andcommitted
Add templates for Pull Requests and Issues (rust-lang#81)
1 parent 2d117b6 commit 452b7ad

File tree

4 files changed

+122
-0
lines changed

4 files changed

+122
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug Report
3+
about: Create a bug report for RMC
4+
labels: bug
5+
---
6+
<!--If you discover a potential security issue in RMC we ask that you notify
7+
AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
8+
Please do **not** create a public github issue.
9+
-->
10+
<!--
11+
Thank you for filing a bug report! 🐛 Please provide a short summary of the bug,
12+
along with any information you feel relevant to replicating the bug.
13+
-->
14+
15+
I tried this code:
16+
<!-- If the code fits into a single file, please post it here. Otherwise please
17+
post a link to the repository and branch that exposes the issue
18+
-->
19+
```rust
20+
<code>
21+
```
22+
23+
using the following command line invocation:
24+
25+
```
26+
<command>
27+
```
28+
29+
with RMC version:
30+
31+
I expected to see this happen: *explanation*
32+
33+
<!--
34+
If RMC crashed, please include a backtrace in the code block by setting
35+
`RUST_BACKTRACE=1` in your environment. E.g. `RUST_BACKTRACE=1 rmc ...`
36+
-->
37+
Instead, this happened: *explanation*
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature Request
3+
about: Create a feature request for RMC
4+
labels:
5+
---
6+
<!--If you discover a potential security issue in RMC we ask that you notify
7+
AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
8+
Please do **not** create a public github issue.
9+
-->
10+
<!--
11+
Thank you for requesting an RMC feature! Please include the
12+
following information if it applies to your case
13+
-->
14+
Requested feature:
15+
Use case:
16+
Link to relevant documentation (Rust reference, Nomicon, RFC):
17+
Is this a breaking change?
18+
19+
Test case:
20+
<!-- If the code fits into a single file, please post it here. Otherwise please
21+
post a link to the repository and branch that exposes the issue
22+
-->
23+
```rust
24+
<code>
25+
```
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Performance Issue
3+
about: Create a performance issue for RMC
4+
labels: bug
5+
---
6+
<!--If you discover a potential security issue in RMC we ask that you notify
7+
AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
8+
Please do **not** create a public github issue.
9+
-->
10+
<!--
11+
Thank you for filing a performance issue! Please provide a short summary of the issue,
12+
along with any information you feel relevant to replicating the issue.
13+
-->
14+
15+
I tried this code:
16+
<!-- If the code fits into a single file, please post it here. Otherwise please
17+
post a link to the repository and branch that exposes the issue
18+
-->
19+
```rust
20+
<code>
21+
```
22+
23+
using the following command line invocation:
24+
25+
```
26+
<command>
27+
```
28+
29+
with RMC version:
30+
31+
If this is a performance regression, how long did it use to take?
32+
Otherwise how much did you expect it to take?
33+
How long did it take?
34+
What stage appears to be the slowest (compilation, verification, code coverage)?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
### Resolved issues:
3+
4+
resolves #ISSUE-NUMBER
5+
6+
### Description of changes:
7+
8+
Describe RMC's current behavior and how your code changes that behavior. If there are no issues this PR is resolving, explain why this change is necessary.
9+
10+
### Call-outs:
11+
12+
<!-- Address any potentially confusing code. Is there code added that needs to be cleaned up later? Is there code that is missing because it’s still in development?
13+
-->
14+
### Testing:
15+
16+
How is this change tested?
17+
18+
Is this a refactor change?
19+
20+
### Checklist
21+
- [ ] Each commit message has a non-empty body, explaining why the change was made
22+
- [ ] Methods or procedures are documented
23+
- [ ] Regression or unit tests are included, or existing tests cover the modified code
24+
- [ ] My PR is restricted to a single feature or bugfix
25+
26+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

0 commit comments

Comments
 (0)