docs: add local security checks section to CONTRIBUTING.md - #620
Open
joshfatoye0011-bit wants to merge 1 commit into
Open
docs: add local security checks section to CONTRIBUTING.md#620joshfatoye0011-bit wants to merge 1 commit into
joshfatoye0011-bit 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
1 participant
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.
Summary\r\n\r\nCloses #519 \r\n\r\nBoth scripts/check-secrets.mjs and scripts/soroban-security-check.mjs run in CI (.github/workflows/security.yml) but were never documented for contributors. This PR adds a Local security checks section to CONTRIBUTING.md so developers can run the same checks locally before pushing.\r\n\r\n## Changes\r\n\r\n- Added a Local security checks section between the testing and code-style sections in CONTRIBUTING.md.\r\n- Documents the exact
ode scripts/check-secrets.mjs command, what patterns it scans for, and what the exit codes mean.\r\n- Documents the exact
ode scripts/soroban-security-check.mjs command with a table of all four rule IDs, their severity, and what each catches.\r\n- Makes clear which findings block merging (HIGH) vs. are non-blocking warnings (LOW).\r\n\r\n## Testing\r\n\r\nDocumentation-only change. No code was modified.