docs: add README documentation security checklist (#1560) - #1579
Open
felipeofdev-ai wants to merge 1 commit into
Open
docs: add README documentation security checklist (#1560)#1579felipeofdev-ai wants to merge 1 commit into
felipeofdev-ai wants to merge 1 commit into
Conversation
felipeofdev-ai
requested review from
RafaelGSS,
lirantal,
mhdawson and
vdeturckheim
as code owners
August 3, 2026 21:32
…1560). Defensive guidance: treat README examples as security-critical surface.
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.
Summary
Adds
processes/readme_security_checklist.mdin response to #1560 (documentation as attack surface).White-hat / defensive only: helps npm maintainers keep README examples aligned with secure library defaults (anchored regex allowlists, crypto-safe randomness, no credential re-injection after redirect stripping, etc.).
Test plan
Felipe Fernandes · Crystal Engineer / Agentic AI
White-hat / defensive only · https://github.com/felipeofdev-ai/secure-ship-kit