docs: add security review preparation checklist#434
Open
sylvarissolutions-max wants to merge 1 commit into
Open
docs: add security review preparation checklist#434sylvarissolutions-max wants to merge 1 commit into
sylvarissolutions-max wants to merge 1 commit into
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
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 #113.
Converts the Trail of Bits blog post on preparing for a security audit into an actionable checklist, with the blockchain-specific additions mentioned in the issue.
What is in this PR
New file: `development-guidelines/preparing-for-a-review.md`
Organized into five sections:
README update: one new bullet under Development Guidelines, alphabetically placed between Incident Response and Secure Development Workflow.
Style and voice
I tried to match the existing checklists in the repo (`token_integration.md` and `review_checklist.md` were the closest references). Every item is a check-boxed imperative with a one-line rationale. I kept the language consistent with those files and avoided adding commentary that was not already in the Trail of Bits post or in the issue comments.
I incorporated the points raised in the issue thread about blockchain-specific preparation: Slither execution, commit hash pinning, reviewer access provisioning, privileged role documentation, and external dependency trust assumptions.
What is NOT in this PR
Happy to adjust the wording, split sections differently, move the file, or restructure if it fits better with the rest of the repo. Let me know.