Skip to content

Create SECURITY.md #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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 [[email protected]](mailto:[email protected]). 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.