Add guidelines for what goes into vstd and how to publish Verus crates on crates.io#2166
Open
Add guidelines for what goes into vstd and how to publish Verus crates on crates.io#2166
Conversation
tjhance
reviewed
Feb 11, 2026
| file that appears on the crates.io landing page. For example, you might say: | ||
| "This crate contains formal specifications and proofs about Widgets, | ||
| primarily for use with [Verus](https://github.com/verus-lang/verus), a tool | ||
| for verifying the correctness of Rust code." |
Collaborator
There was a problem hiding this comment.
For case 1, should we recommend a naming convention? e.g., verus-{}
Collaborator
Author
There was a problem hiding this comment.
I'm open to making that recommendation. @Chris-Hawblitzel, what do you think?
| - We add a `lemma_` prefix to the name of a lemma (i.e., a `proof fn`) to make its purpose explicit. | ||
| - We try to make lemmas associated functions when possible, e.g., `my_map.lemma_remove_keys_len(keys)`, not `lemma_remove_keys_len(my_map, keys)`. | ||
|
|
||
| ## Best practices for publishing Verus-verified code on crates.io |
Collaborator
There was a problem hiding this comment.
should we put this section somewhere more user-facing than in CONTRIBUTING.md?
Collaborator
Author
There was a problem hiding this comment.
I'm open to putting it elsewhere. We've tried to keep the main README.md relatively simple though. We could potentially put it into its own file and then link to it from both README.md and CONTRIBUTING.md. What do you think?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
As discussed at the Verus meeting, here's some documentation on both items. Additional thoughts are quite welcome.
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.