Skip to content

Add community-health files (SECURITY, CONTRIBUTING, templates)#16

Open
VijitSingh97 wants to merge 1 commit into
mainfrom
docs/community-health
Open

Add community-health files (SECURITY, CONTRIBUTING, templates)#16
VijitSingh97 wants to merge 1 commit into
mainfrom
docs/community-health

Conversation

@VijitSingh97
Copy link
Copy Markdown
Contributor

What & why

.github/ had only CODEOWNERS and the lint workflow. This adds the standard launch-readiness community-health files, mirroring Pithead. These are boilerplate docs/meta files — zero code changes.

Added

  • SECURITY.md — vulnerability-reporting policy via GitHub's private "Report a vulnerability" (Security Advisories). Supported version: latest main. Notes that RigForge compiles XMRig from source and applies privileged kernel/MSR tuning, so security matters.
  • CONTRIBUTING.md — how to contribute: run shellcheck rigforge.sh util/proposed-grub.sh before pushing, keep it portable bash, open an issue first for larger changes, PRs require review. Points to the companion Pithead repo.
  • .github/ISSUE_TEMPLATE/bug_report.md & feature_request.md — standard issue templates with YAML front-matter.
  • .github/ISSUE_TEMPLATE/config.ymlblank_issues_enabled: true plus a contact link to Pithead for stack-level questions.
  • .github/PULL_REQUEST_TEMPLATE.md — short what/why + shellcheck/docs checklist.

Left the existing .github/CODEOWNERS untouched. rigforge.sh and README.md are unchanged.

Closes #10

🤖 Generated with Claude Code

Adds the launch-readiness meta files that the .github/ dir was missing:

- SECURITY.md — private vulnerability reporting via GitHub Security
  Advisories; supported version is latest main. Calls out that RigForge
  compiles XMRig from source and applies privileged kernel/MSR tuning.
- CONTRIBUTING.md — local shellcheck workflow, portable-bash guidance,
  open-an-issue-first for larger changes, review requirement, and a
  pointer to the companion Pithead repo.
- .github/ISSUE_TEMPLATE/bug_report.md and feature_request.md — standard
  templates with YAML front-matter.
- .github/ISSUE_TEMPLATE/config.yml — keeps blank issues enabled and adds
  a contact link to Pithead for stack-level questions.
- .github/PULL_REQUEST_TEMPLATE.md — short what/why + shellcheck/docs
  checklist.

No code changes. Closes #10.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.

Community-health files: SECURITY.md, CONTRIBUTING.md, issue/PR templates

1 participant