feat(docs): CONTRIBUTING.md: add guidelines for hax #1126
Conversation
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 PR adds guidelines for hax.
|
Sounds good to me, thank you! |
CONTRIBUTING.md
Outdated
| ### Hax Guidelines | ||
| - Always use the **same version** of the `hax-lib` Cargo dependency throughout the entire workspace. Inconsistencies can lead to build or verification issues (see [issue #1125](https://github.com/cryspen/libcrux/issues/1125)). | ||
| - This repository uses a [Makefile](./fstar-helpers/Makefile.generic) for F\* verification, which relies on Cargo and the workspace's version of `hax-lib` to locate F\* libraries. Specifically, those under the [`proof-libs` directory in hax-lib](https://github.com/cryspen/hax/tree/main/hax-lib/proof-libs). | ||
| - If you need to work with a specific version of `hax-lib` or `proof-libs`, update the `hax-lib` dependency in the workspace's `Cargo.toml`. |
There was a problem hiding this comment.
How do I install the correct version?
|
What's the state here? Shall we get this in? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds guidelines for hax.