Skip to content

Commit 46352cf

Browse files
authored
Introduce tool template (#64)
1 parent 8f3252f commit 46352cf

File tree

2 files changed

+37
-3
lines changed

2 files changed

+37
-3
lines changed

.github/TOOL_REQUEST_TEMPLATE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
_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._
2+
3+
## Tool Name
4+
_Please enter your tool name here._
5+
6+
## Description
7+
_Please enter a description for your tool and any information you deem relevant._
8+
9+
## Tool Information
10+
11+
* [ ] Does the tool perform Rust verification?
12+
* [ ] Does the tool deal with *unsafe* Rust code?
13+
* [ ] Does the tool run independently in CI?
14+
* [ ] Is the tool open source?
15+
* [ ] Is the tool under development?
16+
* [ ] Will you or your team be able to provide support for the tool?
17+
18+
## Licenses
19+
_Please list the license(s) that are used by your tool, and if to your knowledge they conflict with the Rust standard library license(s)._
20+
21+
## Steps to Use the Tool
22+
23+
1. [First Step]
24+
2. [Second Step]
25+
3. [and so on...]
26+
27+
## Artifacts
28+
_If there are noteworthy examples of using the tool to perform verificaiton, please include them in this section.Links, papers, etc._
29+
30+
## CI & Versioning
31+
_Please describe how you version the tool and how it will be supported in CI pipelines._

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
This repository is a fork of the official Rust programming
88
language repository, created solely to verify the Rust standard
99
library. It should not be used as an alternative to the official
10-
Rust releases.
10+
Rust releases. The repository is tool agnostic and welcomes the addition of
11+
new tools.
1112

1213
The goal is to have a verified [Rust standard library](https://doc.rust-lang.org/std/) and prove that it is safe.
1314
1. Contributing to the core mechanism of verifying the rust standard library
@@ -36,12 +37,14 @@ See [SECURITY](https://github.com/model-checking/kani/security/policy) for more
3637
## License
3738

3839
### Kani
39-
4040
Kani is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
4141
See [LICENSE-APACHE](https://github.com/model-checking/kani/blob/main/LICENSE-APACHE) and [LICENSE-MIT](https://github.com/model-checking/kani/blob/main/LICENSE-MIT) for details.
4242

4343
## Rust
44-
4544
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.
4645

4746
See [the Rust repository](https://github.com/rust-lang/rust) for details.
47+
48+
## Introducing a New Tool
49+
50+
Please use the [template available in this repository](.github/TOOL_REQUEST_TEMPLATE.md) to introduce a new verification tool.

0 commit comments

Comments
 (0)