Repository navigation
docs: add a security policy and a contributing guide - #4
Merged
Merged
Conversation
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.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdlinks both from Credits and license.docs/development.md: the release process now usesdev 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 checkis 0/0/0 across the repository (markdownlint, links, Vale, SVGs).bin/dev test prove,crew sync,stubs,ci --run).gh api repos/fireflysoftwaresolutions/devkit/private-vulnerability-reportingreturnsenabled: true, so the advisory link inSECURITY.mdworks.dev ci --runpassed in full (evidence for tree907012d).Risk and rollback
Links