Skip to content

docs: record v0.1.0 release and add security and contributing guides - #15

Merged
ajbeck merged 1 commit into
mainfrom
claude/release-records-security
Oct 2, 2026
Merged

ajbeck merged 1 commit into
mainfrom
claude/release-records-security

Conversation

@ajbeck

@ajbeck ajbeck commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Prepares the repository for going public: it records the v0.1.0 release and adds the two files outside contributors look for first.

Changes

  • Release records. Decision 0024, its index row, docs/release-readiness.md and docs/plan.md now record that Release Please completed end to end and published v0.1.0 at 9423302. The plan's release item is ticked.
  • Decision 0025. Records that the owner will configure branch protection manually. Its recommended rule set stays as the reference.
  • SECURITY.md. Directs reports to GitHub private vulnerability reporting, asks for synthetic credentials only, defines scope, and states that only the latest v0 minor receives fixes. It makes no response-time commitments.
  • CONTRIBUTING.md. Covers Apache-2.0 contribution terms (section 5, no CLA), issue-first for API and trust-boundary changes, the AGENTS.md check commands, the semantic line-break convention, and Conventional Commit titles, including ! for breaking changes (squash merges use the PR title).
  • README. Links both files and fixes the broken link to the action-header example, which moved to actionheader/example_test.go in refactor: move action-header selection to the actionheader package #8.

Validation

Documentation only. Every relative link in every Markdown file resolves, the edited files render, and git diff --check is clean.

Owner follow-up

Private vulnerability reporting is not currently enabled; the API returns 404 while the repository is private. Enable it under Settings → Code security when making the repository public, or SECURITY.md's reporting link won't work.

Record the successful v0.1.0 release in decision 0024, the readiness checklist and the plan, and note in decision 0025 that the owner will configure branch protection manually. Add SECURITY.md for private vulnerability reports and CONTRIBUTING.md with the repository's checks and commit conventions. Fix the README link to the action-header example, which moved to the actionheader package.
@ajbeck
ajbeck merged commit 15b37b4 into main Oct 2, 2026
4 checks passed
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