Skip to content

Add contribution guide, security policy, templates, and test workflow - #155

Open
zachshallbetter wants to merge 1 commit into
cloudflare:mainfrom
zachshallbetter:add-contributing-guide
Open

zachshallbetter wants to merge 1 commit into
cloudflare:mainfrom
zachshallbetter:add-contributing-guide

Conversation

@zachshallbetter

Copy link
Copy Markdown

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 README
  • SECURITY.md
  • .github/ISSUE_TEMPLATE/ with bug report and proposal forms, blank issues off, security contact link
  • .github/pull_request_template.md
  • .github/workflows/test.yml runs 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 timeout

The 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.cjs from skills/security-audit/: 65 pass, 0 fail
  • Parsed the issue forms and the workflow as YAML
  • Checked that all ten companions have the four sections CONTRIBUTING.md names
  • git diff --check

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.
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.

Basic governance: CONTRIBUTING, SECURITY.md, issue and PR templates, and test CI

1 participant