Skip to content

docs: add contributing guide, security policy, and issue/PR templates - #9

Merged
Krustytoe merged 2 commits into
mainfrom
docs/community-health
Oct 30, 2026
Merged

Krustytoe merged 2 commits into
mainfrom
docs/community-health

Conversation

@Krustytoe

Copy link
Copy Markdown
Owner

What

  • CONTRIBUTING.md: branch → Conventional Commit PR title (drives release-please) → green CI; local check commands mirror this repo's CI exactly; repo-specific conventions
  • SECURITY.md: points to GitHub private vulnerability reporting (now enabled on the repo); asks reporters to redact IDs/credentials
  • Issue forms (bug/feature, blank issues off, security contact link) and a PR template with a validation checklist
  • README badges: CI, latest release, license
  • Usage examples pinned to the latest release. They pointed at ?ref=v0.1.0. Each ref now carries # x-release-please-version and README.md is in release-please extra-files, so it bumps automatically on every release

Why

Raises the GitHub community profile from 42% and makes the repo easier to evaluate and contribute to. Docs and CI only: no module, rule, or workflow behaviour changes.

Validation

  • Command lists in CONTRIBUTING.md were taken from the CI workflow files
  • CI on this PR

🤖 Generated with Claude Code

Krustytoe and others added 2 commits October 30, 2026 08:48
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The usage examples still pointed at v0.1.0. release-please now bumps the ref in
README.md on each release so it can't drift again.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Krustytoe
Krustytoe merged commit 37c02a3 into main Oct 30, 2026
5 checks passed
@Krustytoe
Krustytoe deleted the docs/community-health branch October 30, 2026 14:06
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