Repository navigation
Add contribution guide, security policy, templates, and test workflow - #155
Open
zachshallbetter wants to merge 1 commit into
Open
zachshallbetter wants to merge 1 commit into
zachshallbetter wants to merge 1 commit into
Conversation
The repository has no contribution guidance of its own, no issue or pull request templates, no security policy, and nothing that runs the validator test suites. Contributors have been opening overlapping and conflicting pull requests against the same validator files, and some vulnerability reports have arrived as public issues. CONTRIBUTING.md states the repository-specific rules the existing files already follow: issue-first proposals, one change per pull request, the shared companion section schema, verbatim prompt blocks, prose and schema agreement, dependency-free validators, and the test command. SECURITY.md points to Cloudflare's disclosure process, matching other Cloudflare repositories. The issue templates replace blank issues with a bug report and a proposal form, and route security reports away from public issues. The pull request template asks for the validation commands that were run. The test workflow runs both validator suites on pull requests and pushes to main that touch the skill, with read-only permissions, pinned actions, a concurrency group, and a job timeout.
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.
Summary
Adds the contribution guidance the repo is missing. CONTRIBUTING.md writes down conventions the existing files already follow, it doesn't introduce new ones. SECURITY.md matches the one in workers-sdk.
CONTRIBUTING.md, plus a short Contributing section in the READMESECURITY.md.github/ISSUE_TEMPLATE/with bug report and proposal forms, blank issues off, security contact link.github/pull_request_template.md.github/workflows/test.ymlruns both validator suites on PRs and pushes to main that touch the skill. Token is read-only, actions are pinned to SHAs, there's a concurrency group and a 10 minute timeoutThe workflow overlaps #33, #75 and #99, which add the same
.github/workflows/test.yml, and #14 adds a similar Contributing section to the README. Happy to drop either part from this PR if you'd rather merge one of those.Closes #154
Validation
node --test validate-findings.test.cjs validate-coverage-ledger.test.cjsfromskills/security-audit/: 65 pass, 0 failgit diff --check