Skip to content

docs: add a security policy and a contributing guide - #4

Merged
ancongui merged 1 commit into
mainfrom
docs/security-and-contributing
Nov 6, 2026
Merged

ancongui merged 1 commit into
mainfrom
docs/security-and-contributing

Conversation

@ancongui

@ancongui ancongui commented Nov 6, 2026

Copy link
Copy Markdown
Collaborator

What and why

The repository is public, so people need to know how to report a vulnerability privately and how to propose a change.

Changes

  • SECURITY.md: supported versions, GitHub private vulnerability reporting (now enabled on the repository), what happens after a report, what is in and out of scope, and how the repository is protected.
  • CONTRIBUTING.md: issues first for larger changes, working on a clone without installing devkit, how to make a change, the checks a pull request must pass, commits and pull requests, and the Apache-2.0 inbound terms.
  • README.md links both from Credits and license.
  • docs/development.md: the release process now uses dev pr merge, dev release, and a check of the published archive, instead of raw commands the guard refuses.
  • CHANGELOG.md [Unreleased]: both entries.

How to verify

  • dev docs check is 0/0/0 across the repository (markdownlint, links, Vale, SVGs).
  • Every command the guides name exists (bin/dev test prove, crew sync, stubs, ci --run).
  • gh api repos/fireflysoftwaresolutions/devkit/private-vulnerability-reporting returns enabled: true, so the advisory link in SECURITY.md works.
  • dev ci --run passed in full (evidence for tree 907012d).

Risk and rollback

  • Documentation only; revert the merge to roll back. Private vulnerability reporting is a repository setting: turn it off in Settings › Security if needed.

Links

The repository is public, so people need to know how to report a vulnerability privately and how to propose a change. SECURITY.md covers the supported versions, GitHub's private vulnerability reporting (now on), what happens after a report, and what is in and out of scope; CONTRIBUTING.md covers issues first, working on a clone without installing devkit, the change, the checks a pull request must pass, commits and pull requests, and the Apache-2.0 inbound terms. The README links both, and Developing devkit now describes the real release flow (dev pr merge, dev release, a check of the published archive) instead of raw commands the guard refuses.
@ancongui
ancongui merged commit 8476ee3 into main Nov 6, 2026
3 checks passed
@ancongui
ancongui deleted the docs/security-and-contributing branch November 6, 2026 11:09
@ancongui ancongui mentioned this pull request Nov 6, 2026
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.

1 participant