Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,21 @@ name: Bug Report
about: Create a bug report for RMC
labels: bug
---
<!--If you discover a potential security issue in RMC we ask that you notify
AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
Please do **not** create a public github issue.
<!--
Please report security concerns to us on the
[AWS vulnerability reporting](http://aws.amazon.com/security/vulnerability-reporting/) page.
-->

<!--
Thank you for filing a bug report! 🐛 Please provide a short summary of the bug,
along with any information you feel relevant to replicating the bug.
Thank you for filing a bug report! 🐛
Please provide a short summary of the issue, along with the information necessary to replicate.
-->

I tried this code:
<!-- If the code fits into a single file, please post it here. Otherwise please
post a link to the repository and branch that exposes the issue
<!--
If the reproducing code is small, please post it here.
Otherwise, please attach the relevant files to this issue.
Alternatively, post a link to the repository and branch that exposes the issue.
-->
```rust
<code>
Expand Down
16 changes: 9 additions & 7 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,24 @@ name: Feature Request
about: Create a feature request for RMC
labels:
---
<!--If you discover a potential security issue in RMC we ask that you notify
AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
Please do **not** create a public github issue.
<!--
Please report security concerns to us on the
[AWS vulnerability reporting](http://aws.amazon.com/security/vulnerability-reporting/) page.
-->

<!--
Thank you for requesting an RMC feature! Please include the
following information if it applies to your case
Thank you for requesting an RMC feature!
Please include the following information if it applies to your case:
-->
Requested feature:
Use case:
Link to relevant documentation (Rust reference, Nomicon, RFC):
Is this a breaking change?

Test case:
<!-- If the code fits into a single file, please post it here. Otherwise please
post a link to the repository and branch that exposes the issue
<!--
If the test-case is small, please post it here.
Otherwise, please attach the relevant files to this issue.
-->
```rust
<code>
Expand Down
17 changes: 10 additions & 7 deletions .github/ISSUE_TEMPLATE/performance_issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,21 @@ name: Performance Issue
about: Create a performance issue for RMC
labels: bug
---
<!--If you discover a potential security issue in RMC we ask that you notify
AWS Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
Please do **not** create a public github issue.
<!--
Please report security concerns to us on the
[AWS vulnerability reporting](http://aws.amazon.com/security/vulnerability-reporting/) page.
-->

<!--
Thank you for filing a performance issue! Please provide a short summary of the issue,
along with any information you feel relevant to replicating the issue.
Thank you for filing a performance issue!
Please provide a short summary of the issue, along with the information necessary to replicate.
-->

I tried this code:
<!-- If the code fits into a single file, please post it here. Otherwise please
post a link to the repository and branch that exposes the issue
<!--
If the reproducing code is small, please post it here.
Otherwise, please attach the relevant files to this issue.
Alternatively, post a link to the repository and branch that exposes the issue.
-->
```rust
<code>
Expand Down
17 changes: 10 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@

### Resolved issues:

resolves #ISSUE-NUMBER

### Description of changes:

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.

### Resolved issues:

Resolves #ISSUE-NUMBER


### Call-outs:

<!-- 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?
<!--
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?
-->

### Testing:

How is this change tested?
* How is this change tested?

Is this a refactor change?
* Is this a refactor change?

### Checklist
- [ ] Each commit message has a non-empty body, explaining why the change was made
Expand Down
10 changes: 3 additions & 7 deletions DEVELOPER-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,7 @@ This is the branch that you should build and use, and this is the branch that yo
### Patch structure
The `main-<upstream-version>-yyyy-mm-dd` branches have the following git structure:

* A set of commits representing RMC feature code.
These patches only affect RMC files.
Any API changes are contained in a single commit, described below.
* A single patch which renames any upstream files that conflict with RMC files
* A single patch that applies any API changes needed to the upstream code for RMC to link
* The upstream `master` branch as of the date `yyyy-mm-dd`.


* A source code patch that makes all changes to the upstream code needed for RMC to link.
* A renaming patch that renames upstream files that conflict with RMC files.
* A set of commits representing RMC feature code.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ The Rust Model Checker (RMC) aims to be a bit-precise model-checker for Rust.

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