From 76d4e55b05fe63f1f1eee731c2bbeda104f412a5 Mon Sep 17 00:00:00 2001 From: Karan Thakkar Date: Thu, 11 Dec 2025 22:07:12 +0000 Subject: [PATCH] feat: add security policy and issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 57 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 35 +++++++++++++ SECURITY.md | 28 +++++++++++ 3 files changed, 120 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..872d218 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,57 @@ +name: 🐛 Bug Report +description: Create a report to help us improve AutoRedact +title: "[Bug]: " +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: When I upload a PDF, the screen turns blank... + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + - type: dropdown + id: browser + attributes: + label: Browser + options: + - Chrome + - Firefox + - Safari + - Edge + - Other + validations: + required: true + - type: dropdown + id: platform + attributes: + label: Platform + options: + - Desktop (macOS) + - Desktop (Windows) + - Desktop (Linux) + - Mobile (iOS/Android) + validations: + required: true + - type: textarea + id: logs + attributes: + label: Screenshots or Console Logs + description: Paste any console errors (F12) or screenshots here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..d197f77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,35 @@ +name: 💡 Feature Request +description: Suggest an idea or enhancement for AutoRedact +title: "[Feat]: " +labels: ["enhancement", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for asking for a new feature! Please search existing issues first. + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when... + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + placeholder: I want a button that auto-downloads all images as ZIP... + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..b66ec02 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,28 @@ +# Security Policy + +## Supported Versions + +AutoRedact is an aggressive release project. **We only support the latest release.** + +| Version | Supported | +| ------- | ------------------ | +| Latest | :white_check_mark: | +| < 1.0.0 | :x: | + +If you are running an older version, please upgrade immediately. We do not backport security fixes to older versions. + +## Reporting a Vulnerability + +We take security seriously. If you discover a security vulnerability in AutoRedact, please follow these steps to report it responsibly: + +### ⛔ DO NOT OPEN A PUBLIC ISSUE + +Publicly reporting a vulnerability can put the community at risk before a fix is available. + +### ✅ Private Reporting (Recommended) + +We use **GitHub Private Vulnerability Reporting**. This allows you to open a private advisory directly in this repository. + +1. Go to the **Security** tab. +2. Click **"Report a vulnerability"** (green button). +3. Fill in the details.