docs: add AUDIT_PREP.md checklist for security audits - #2387
Merged
Conversation
5 tasks
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
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.
Closes #1916
resolves #1916
fixes #1916
Description
This PR introduces a comprehensive security audit preparation checklist (
docs/AUDIT_PREP.md) targeted at contributors. It serves to standardize the preparation process, replacing tribal knowledge with a codified set of steps.Changes Made
docs/AUDIT_PREP.mdwith detailed instructions on what to hand over to the auditor, what to verify locally before handing over the codebase, and what to expect during the audit lifecycle.#![no_std]discipline, clearing out TODOs, and provided exact CLI commands for running WASM compilation, tests, and lints.README.mdanddocs/README.mdto ensure it is highly discoverable.Verification
cargo doccompilation instructions are correct.