Skip to content

Create SECURITY.md#810

Merged
igorls merged 2 commits intoMemPalace:developfrom
Yorji-Porji:patch-1
Apr 14, 2026
Merged

Create SECURITY.md#810
igorls merged 2 commits intoMemPalace:developfrom
Yorji-Porji:patch-1

Conversation

@Yorji-Porji
Copy link
Copy Markdown
Contributor

This PR introduces a standard SECURITY.md policy file to the repository.

While reviewing the codebase, I noticed there wasn't a defined channel for the private, responsible disclosure of security vulnerabilities. Adding this policy helps protect the project by guiding researchers to report bugs privately rather than in public issues.

I highly recommend merging this and enabling GitHub's "Private Vulnerability Reporting" feature in your repository settings. I currently have some security findings I would like to share with the maintainers securely once a private channel or contact method is established.

What does this PR do?

How to test

Checklist

  • Tests pass (python -m pytest tests/ -v)
  • No hardcoded paths
  • Linter passes (ruff check .)

This PR introduces a standard SECURITY.md policy file to the repository. 

While reviewing the codebase, I noticed there wasn't a defined channel for the private, responsible disclosure of security vulnerabilities. Adding this policy helps protect the project by guiding researchers to report bugs privately rather than in public issues. 

I highly recommend merging this and enabling GitHub's "Private Vulnerability Reporting" feature in your repository settings. I currently have some security findings I would like to share with the maintainers securely once a private channel or contact method is established.
@igorls igorls added documentation Improvements or additions to documentation security Security related labels Apr 14, 2026
…nnel

Builds on @Yorji-Porji's draft by fixing three issues before it lands:

- Replace the `< 1.0.0` placeholder table with MemPalace's actual
  support policy: current major (3.x) receives fixes, 2.x and earlier
  do not.
- Remove the `[Insert Maintainer Email Here]` placeholder and the
  email fallback. GitHub Private Vulnerability Reporting is enabled
  on this repo; the policy points there exclusively so there is no
  risk of a researcher emailing a dead address.
- Drop the meta-note ("Adjust the table above…") that was an
  instruction to the maintainer, not policy text.

Structure, triage timelines, and credit language are kept as drafted.
@igorls
Copy link
Copy Markdown
Collaborator

igorls commented Apr 14, 2026

Thanks for filing this and for flagging the GHPVR feature. Pushed a follow-up commit directly to your branch to tighten a few things before merge:

  • Fixed the version table to reflect MemPalace's actual release line (3.x current, 2.x and earlier unsupported) and removed the "Adjust the table above" TODO note.
  • Dropped the `[Insert Maintainer Email Here]` placeholder and the email fallback entirely. Private Vulnerability Reporting is being enabled on the repo, so the policy now points researchers there exclusively — no risk of your disclosures going to a dead address.
  • Kept your structure, triage timelines (48h ack, advisory credit), and "what to include" checklist. Those were the right bones.

Once GHPVR enabled is you'll be able to file your findings via the Security → Advisories → Report a vulnerability flow on this repo. Planning to merge this shortly.

@igorls igorls merged commit 4de9e13 into MemPalace:develop Apr 14, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation security Security related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants