Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce tool template #64

Merged
merged 5 commits into from
Aug 22, 2024
Merged

Introduce tool template #64

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2afb701
introduce tool template
rahulku Aug 21, 2024
ce7b88f
revisions
rahulku Aug 21, 2024
e0d7018
fix headings
rahulku Aug 21, 2024
8f11169
relative link for template
rahulku Aug 21, 2024
81005d3
Merge branch 'main' into new-tool-template
rahulku Aug 22, 2024
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
31 changes: 31 additions & 0 deletions .github/TOOL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
_The following form is designed to provide information for your tool that should be included in the effort to verify the Rust standard library. Please note that the tool will need to be supported if it is to be included._

## Tool Name
_Please enter your tool name here._

## Description
_Please enter a description for your tool and any information you deem relevant._

### Tool Information

* [ ] Does the tool perform Rust verification?
* [ ] Does the tool deal with *unsafe* Rust code?
* [ ] Does the tool run independently in CI?
* [ ] Is the tool open source?
* [ ] Is the tool under development?
* [ ] Will you or your team be able to provide support for the tool?

### Licenses
<!-- Please list the licenses that the tool uses and can be used under. -->

### Steps to Use the Tool

1. [First Step]
2. [Second Step]
3. [and so on...]

### Artifacts
jaisnan marked this conversation as resolved.
Show resolved Hide resolved
_If there are noteworthy examples of using the tool to perform verificaiton, please include them in this section.Links, papers, etc._

### CI & Versioning
_Please describe how you version the tool and how it will be supported in CI pipelines._
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
This repository is a fork of the official Rust programming
language repository, created solely to verify the Rust standard
library. It should not be used as an alternative to the official
Rust releases.
Rust releases. The repository is tool agnostic and welcomes the addition of
new tools.

The goal is to have a verified [Rust standard library](https://doc.rust-lang.org/std/) and prove that it is safe.
1. Contributing to the core mechanism of verifying the rust standard library
Expand Down Expand Up @@ -45,3 +46,7 @@ See [LICENSE-APACHE](https://github.com/model-checking/kani/blob/main/LICENSE-AP
Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See [the Rust repository](https://github.com/rust-lang/rust) for details.

## Introducing a New Tool

Please use the [template available in this repository](https://github.com/model-checking/kani/.github/TOOL_REQUEST_TEMPLATE.md) to introduce a new verification tool.
Loading