Skip to content

Create SECURITY.md for security policy#8827

Open
HK4zCzi wants to merge 2 commits into
AppFlowy-IO:mainfrom
HK4zCzi:patch-1
Open

Create SECURITY.md for security policy#8827
HK4zCzi wants to merge 2 commits into
AppFlowy-IO:mainfrom
HK4zCzi:patch-1

Conversation

@HK4zCzi

@HK4zCzi HK4zCzi commented Jun 19, 2026

Copy link
Copy Markdown

Added a security policy document outlining supported versions and vulnerability reporting.

Feature Preview


PR Checklist

  • My code adheres to AppFlowy's Conventions
  • I've listed at least one issue that this PR fixes in the description above.
  • I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
  • All existing tests are passing.

Summary by Sourcery

Documentation:

  • Introduce SECURITY.md describing supported versions and guidance on reporting security vulnerabilities.

Added a security policy document outlining supported versions and vulnerability reporting.
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@sourcery-ai

sourcery-ai Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Adds a new SECURITY.md document that outlines a template security policy including supported versions and guidance for reporting vulnerabilities.

File-Level Changes

Change Details Files
Introduce a SECURITY.md file documenting security policy structure, supported versions table, and vulnerability reporting guidance placeholders.
  • Create SECURITY.md with a top-level Security Policy heading and sections for Supported Versions and Reporting a Vulnerability
  • Add a markdown table indicating which example versions are considered supported vs unsupported for security updates
  • Include placeholder text instructing maintainers to describe their vulnerability reporting process and expectations for reporters
SECURITY.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue, and left some high level feedback:

  • The Supported Versions table appears to use placeholder versions (5.x/4.x); consider updating this to match the actual release/versioning scheme used in the project so the policy is actionable.
  • The Reporting a Vulnerability section still contains template guidance text; replace this with concrete instructions (e.g., email address, security disclosure process, expected response timelines) tailored to this project.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The `Supported Versions` table appears to use placeholder versions (5.x/4.x); consider updating this to match the actual release/versioning scheme used in the project so the policy is actionable.
- The `Reporting a Vulnerability` section still contains template guidance text; replace this with concrete instructions (e.g., email address, security disclosure process, expected response timelines) tailored to this project.

## Individual Comments

### Comment 1
<location path="SECURITY.md" line_range="5-6" />
<code_context>
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
</code_context>
<issue_to_address>
**suggestion (typo):** Consider simplifying the phrase "about which versions" to "which versions" for smoother grammar.

Rephrasing to “Use this section to tell people which versions of your project are currently being supported with security updates.” reads more naturally and avoids the clunky “about which” wording.

```suggestion
Use this section to tell people which versions of your project are
currently being supported with security updates.
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread SECURITY.md Outdated
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants