chore: track audit prompt, ignore generated audit report#58
Merged
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.
What
.gitignorerules so the local security-audit report stays untracked, while the prompt is version-controlled:audit/audit-prompt.md(the reusable audit instructions).Why
The
audit/folder holds a generated security review of this repository, including detailed exploit scenarios and attack chains. On a public repo those artifacts should not be committed — that would publish an exploit guide for as-yet-unfixed findings. The prompt that produces the report, however, is safe and useful to keep in the repo so the audit can be re-run.Reviewer notes
.gitignore(+4 lines) and the newaudit/audit-prompt.md.git check-ignore: the generated report files (e.g.audit/scorecard.md,audit/executive-summary.md) are ignored;audit/audit-prompt.mdis not.security), sanitized to omit exploit walkthroughs.