forked from rust-lang/rust
-
Notifications
You must be signed in to change notification settings - Fork 53
Add initial challenge template #10
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,59 @@ | ||
# Challenge Template | ||
# Challenge XXXX[^challenge_id]: Challenge Title | ||
|
||
- **Status:** *One of the following: [Open | Resolved | Expired]* | ||
- **Solution:** *Option field to point to the PR that solved this challenge.* | ||
- **Tracking Issue:** *Link to issue* | ||
- **Start date:** *YY/MM/DD* | ||
- **End date:** *YY/MM/DD* | ||
|
||
------------------- | ||
|
||
|
||
## Goal | ||
|
||
*Describe the goal of this challenge with 1-2 sentences.* | ||
|
||
## Motivation | ||
|
||
*Explain why this is a challenge that should be prioritized. Consider using a motivating example.* | ||
|
||
## Description | ||
|
||
*Describe the challenge in more details.* | ||
|
||
### Assumptions | ||
|
||
*Mention any assumption that users may make. Example, "assuming the usage of Stacked Borrows".* | ||
|
||
### Success Criteria* | ||
|
||
*Here are some examples of possible criteria:* | ||
|
||
All the following unsafe functions must be annotated with safety contracts and the contracts have been verified: | ||
|
||
|Function |Location | | ||
|--- |--- | | ||
| | | | ||
| | | | ||
| | | | ||
| | | | ||
| | | | ||
|
||
At least N of the following usages were proven safe: | ||
|
||
|Function |Location | | ||
|--- |--- | | ||
| | | | ||
| | | | ||
| | | | ||
| | | | ||
| | | | ||
|
||
All proofs must automatically ensure the absence of the following undefined behaviors [[ref]](https://github.com/rust-lang/reference/blob/142b2ed77d33f37a9973772bd95e6144ed9dce43/src/behavior-considered-undefined.md): | ||
|
||
*List of UBs* | ||
|
||
Note: All solutions to verification challenges need to satisfy the criteria established in the [challenge book](general-rules.md) | ||
in addition to the ones listed above. | ||
|
||
[^challenge_id]: The number of the challenge sorted by publication date. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.