diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 410cfb4f690a..d24f6230226d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,18 +3,21 @@ name: Bug Report about: Create a bug report for RMC labels: bug --- - + I tried this code: - ```rust diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 4fb0ab9fd799..53e4b54e702a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -3,13 +3,14 @@ name: Feature Request about: Create a feature request for RMC labels: --- - + Requested feature: Use case: @@ -17,8 +18,9 @@ Link to relevant documentation (Rust reference, Nomicon, RFC): Is this a breaking change? Test case: - ```rust diff --git a/.github/ISSUE_TEMPLATE/performance_issue.md b/.github/ISSUE_TEMPLATE/performance_issue.md index 42c4f878284a..02e3ed931966 100644 --- a/.github/ISSUE_TEMPLATE/performance_issue.md +++ b/.github/ISSUE_TEMPLATE/performance_issue.md @@ -3,18 +3,21 @@ name: Performance Issue about: Create a performance issue for RMC labels: bug --- - + I tried this code: - ```rust diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 23d260422aea..90a9432abbe6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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: - + ### 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 diff --git a/DEVELOPER-GUIDE.md b/DEVELOPER-GUIDE.md index 9e8716da5702..9de743fba2a9 100644 --- a/DEVELOPER-GUIDE.md +++ b/DEVELOPER-GUIDE.md @@ -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--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. diff --git a/README.md b/README.md index d5922e66af6a..7a658527bf52 100644 --- a/README.md +++ b/README.md @@ -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).