From 2d79994181b9fffcaa788199eecd1516c2e3a593 Mon Sep 17 00:00:00 2001 From: Harish Ghasolia <100846446+harishghasolia07@users.noreply.github.com> Date: Wed, 4 Jun 2025 12:58:42 +0530 Subject: [PATCH] Create SECURITY.md --- SECURITY.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..25fdba2 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,35 @@ +# Security Policy + +## Privacy and Code Handling + +We take code privacy seriously. If our platform processes a user's GitHub repository, we acknowledge the potential exposure of proprietary logic and sensitive implementation details. + +To protect user privacy, we strongly recommend and are working toward implementing the following: + +- ✅ Provide an option for users to **download** the generated documentation locally. +- ✅ Allow users to **delete their generated documentation** from our servers immediately after download. +- ✅ Implement an **auto-delete policy**, where all uploaded or fetched content is permanently removed after a short period (e.g., 24 hours). +- ✅ Clearly document what data is stored, for how long, and who has access to it. + +We are committed to ensuring our platform does not retain user code longer than necessary and never exposes it to the public or unauthorized users. + +## Supported Versions + +| Version | Supported | +| ------- | ------------------ | +| 5.1.x | ✅ | +| 5.0.x | ❌ | +| 4.0.x | ✅ | +| < 4.0 | ❌ | + +## Reporting a Vulnerability + +To report a vulnerability or privacy issue, please email us at [security@example.com](mailto:security@example.com). We aim to respond within 3 business days and resolve critical issues as quickly as possible. + +When reporting, please include: + +- A detailed description of the issue. +- Steps to reproduce (if applicable). +- Any screenshots, logs, or evidence of the problem. + +We appreciate responsible disclosure and are committed to protecting our users' privacy and data.