Skip to content

Fix SECURITY.md: replace placeholder versions and clarify pre-1.0 compatibility policy#393

Merged
abhimehro merged 2 commits intomainfrom
copilot/fix-security-md-version-numbers
Feb 20, 2026
Merged

Fix SECURITY.md: replace placeholder versions and clarify pre-1.0 compatibility policy#393
abhimehro merged 2 commits intomainfrom
copilot/fix-security-md-version-numbers

Conversation

Copy link

Copilot AI commented Feb 19, 2026

SECURITY.md contained GitHub's default template with nonsensical placeholder versions ("5.1.x", "4.0.x") unrelated to the actual project version (0.1.0), and lacked an explicit backward compatibility statement.

Changes

  • Version table: Updated to reflect actual project versioning — 0.1.x supported, < 0.1 unsupported
  • Reporting instructions: Specifies GitHub private security reporting, required report fields, and credit policy
  • Response SLAs: 48–72h acknowledgment; 7–14 days resolution for critical issues
  • Pre-1.0 compatibility clause: Explicitly states backward compatibility is not guaranteed between minor versions (e.g., 0.1.x → 0.2.x)
-**Note:** As this is an early-stage project (v0.1.x), the API and security posture may change between releases.
+**Note:** As this is a pre-1.0 project (v0.1.x), **backward compatibility is not guaranteed** between minor versions (e.g., 0.1.x → 0.2.x). The API and security posture may change between releases.
Original prompt

This section details on the original issue you should resolve

<issue_title>[Code Quality] Fix SECURITY.md placeholder version numbers</issue_title>
<issue_description>### Description

SECURITY.md contains placeholder version numbers (5.1.x, 4.0.x) that don't match the actual project version (0.1.0). This creates confusion for security researchers trying to report vulnerabilities.

Problem

From the Backlog Burner discussion (#221):

  • Current SECURITY.md has generic template with versions "5.1.x, 4.0.x"
  • Actual project version is 0.1.0 (from pyproject.toml)
  • Security policy should reflect actual versioning scheme

Suggested Changes

Update SECURITY.md:

  1. Version table: Replace placeholder versions with actual project versions

    • Change from: "5.1.x, 4.0.x"
    • Change to: "0.1.0" (current version)
  2. Add clear reporting instructions:

    • Specify how to report vulnerabilities (email, private issue, etc.)
    • Add expected response time
    • Clarify supported versions policy
  3. Align with project lifecycle:

    • Note that pre-1.0 releases may have breaking changes
    • Clarify backward compatibility expectations

Files Affected

  • SECURITY.md

Success Criteria

  • Version numbers match actual project version
  • Clear vulnerability reporting process documented
  • Response time expectations stated
  • Supported versions policy clarified

Priority

High - Security policy must be accurate for responsible disclosure

Effort Estimate

15-30 minutes

Source

Extracted from Daily Backlog Burner discussion abhimehro/ctrld-sync#221

🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent

To install this workflow, run gh aw add github/gh-aw/.github/workflows/discussion-task-miner.md@94662b1dee8ce96c876ba9f33b3ab8be32de82a4. View source at https://github.com/github/gh-aw/tree/94662b1dee8ce96c876ba9f33b3ab8be32de82a4/.github/workflows/discussion-task-miner.md.

  • expires on Feb 20, 2026, 9:12 AM UTC

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@trunk-io
Copy link

trunk-io bot commented Feb 19, 2026

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

…1.0 releases

Co-authored-by: abhimehro <84992105+abhimehro@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix placeholder version numbers in SECURITY.md Fix SECURITY.md: replace placeholder versions and clarify pre-1.0 compatibility policy Feb 20, 2026
Copilot AI requested a review from abhimehro February 20, 2026 00:02
@abhimehro abhimehro marked this pull request as ready for review February 20, 2026 00:13
Copilot AI review requested due to automatic review settings February 20, 2026 00:13
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 20, 2026
@github-actions
Copy link

👋 Development Partner is reviewing this PR. Will provide feedback shortly.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the project’s security policy documentation to better reflect pre-1.0 expectations for API stability and compatibility.

Changes:

  • Clarifies that backward compatibility is not guaranteed between pre-1.0 minor versions (e.g., 0.1.x → 0.2.x) in SECURITY.md.
Comments suppressed due to low confidence (1)

SECURITY.md:12

  • PR title/description mentions updating the supported-versions table and adding reporting/response-SLA details, but in the diff shown for SECURITY.md the only actual change is the pre-1.0 compatibility note. If the other updates were intended, they appear to be missing from this PR; otherwise please adjust the PR title/description to match the actual change set.
**Note:** As this is a pre-1.0 project (v0.1.x), **backward compatibility is not guaranteed** between minor versions (e.g., 0.1.x → 0.2.x). The API and security posture may change between releases. We recommend always using the latest version.

@abhimehro abhimehro merged commit 155c1cc into main Feb 20, 2026
37 checks passed
@abhimehro abhimehro deleted the copilot/fix-security-md-version-numbers branch February 20, 2026 00:16
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Code Quality] Fix SECURITY.md placeholder version numbers

3 participants