Skip to content

Commit 2efd53f

Browse files
danielsntedinski
authored andcommitted
Minor tweaks to the documentation (rust-lang#100)
1 parent d7440b9 commit 2efd53f

File tree

6 files changed

+43
-36
lines changed

6 files changed

+43
-36
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@ name: Bug Report
33
about: Create a bug report for RMC
44
labels: bug
55
---
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.
6+
<!--
7+
Please report security concerns to us on the
8+
[AWS vulnerability reporting](http://aws.amazon.com/security/vulnerability-reporting/) page.
99
-->
10+
1011
<!--
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.
12+
Thank you for filing a bug report! 🐛
13+
Please provide a short summary of the issue, along with the information necessary to replicate.
1314
-->
1415

1516
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
17+
<!--
18+
If the reproducing code is small, please post it here.
19+
Otherwise, please attach the relevant files to this issue.
20+
Alternatively, post a link to the repository and branch that exposes the issue.
1821
-->
1922
```rust
2023
<code>

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,24 @@ name: Feature Request
33
about: Create a feature request for RMC
44
labels:
55
---
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.
6+
<!--
7+
Please report security concerns to us on the
8+
[AWS vulnerability reporting](http://aws.amazon.com/security/vulnerability-reporting/) page.
99
-->
10+
1011
<!--
11-
Thank you for requesting an RMC feature! Please include the
12-
following information if it applies to your case
12+
Thank you for requesting an RMC feature!
13+
Please include the following information if it applies to your case:
1314
-->
1415
Requested feature:
1516
Use case:
1617
Link to relevant documentation (Rust reference, Nomicon, RFC):
1718
Is this a breaking change?
1819

1920
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
21+
<!--
22+
If the test-case is small, please post it here.
23+
Otherwise, please attach the relevant files to this issue.
2224
-->
2325
```rust
2426
<code>

.github/ISSUE_TEMPLATE/performance_issue.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@ name: Performance Issue
33
about: Create a performance issue for RMC
44
labels: bug
55
---
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.
6+
<!--
7+
Please report security concerns to us on the
8+
[AWS vulnerability reporting](http://aws.amazon.com/security/vulnerability-reporting/) page.
99
-->
10+
1011
<!--
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.
12+
Thank you for filing a performance issue!
13+
Please provide a short summary of the issue, along with the information necessary to replicate.
1314
-->
1415

1516
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
17+
<!--
18+
If the reproducing code is small, please post it here.
19+
Otherwise, please attach the relevant files to this issue.
20+
Alternatively, post a link to the repository and branch that exposes the issue.
1821
-->
1922
```rust
2023
<code>

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
11

2-
### Resolved issues:
3-
4-
resolves #ISSUE-NUMBER
5-
62
### Description of changes:
73

84
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.
95

6+
### Resolved issues:
7+
8+
Resolves #ISSUE-NUMBER
9+
10+
1011
### Call-outs:
1112

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+
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?
1315
-->
16+
1417
### Testing:
1518

16-
How is this change tested?
19+
* How is this change tested?
1720

18-
Is this a refactor change?
21+
* Is this a refactor change?
1922

2023
### Checklist
2124
- [ ] Each commit message has a non-empty body, explaining why the change was made

DEVELOPER-GUIDE.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,7 @@ This is the branch that you should build and use, and this is the branch that yo
4040
### Patch structure
4141
The `main-<upstream-version>-yyyy-mm-dd` branches have the following git structure:
4242

43-
* A set of commits representing RMC feature code.
44-
These patches only affect RMC files.
45-
Any API changes are contained in a single commit, described below.
46-
* A single patch which renames any upstream files that conflict with RMC files
47-
* A single patch that applies any API changes needed to the upstream code for RMC to link
4843
* The upstream `master` branch as of the date `yyyy-mm-dd`.
49-
50-
44+
* A source code patch that makes all changes to the upstream code needed for RMC to link.
45+
* A renaming patch that renames upstream files that conflict with RMC files.
46+
* A set of commits representing RMC feature code.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ The Rust Model Checker (RMC) aims to be a bit-precise model-checker for Rust.
33

44
## Project Status
55
RMC is currently in the initial development phase.
6-
It **does not support all rust language features**.
6+
It **does not yet support all rust language features**.
77
We are working to extend our support of language features.
88
If you encounter issues when using RMC we encourage you to
99
[report them to us](https://github.com/model-checking/rmc/issues/new/choose).

0 commit comments

Comments
 (0)