Skip to content

docs: add community health files (code of conduct, contributing, templates, security policy)Docs - #3

Merged
scr0ols merged 14 commits into
mainfrom
docs
Jul 17, 2026
Merged

docs: add community health files (code of conduct, contributing, templates, security policy)Docs#3
scr0ols merged 14 commits into
mainfrom
docs

Conversation

@scr0ols

@scr0ols scr0ols commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Brings the repo up to GitHub's Community Standards checklist ahead of launch. All content added via GitHub's own template wizards where one existed, hand-written where it didn't.

Added

  • CODE_OF_CONDUCT.md (Contributor Covenant)
  • CONTRIBUTING.md (bug reports, PR process, commit convention, code style)
  • .github/ISSUE_TEMPLATE/ (bug report, feature request)
  • .github/PULL_REQUEST_TEMPLATE.md
  • SECURITY.md (private vulnerability reporting via GitHub)

Changed

  • README.md brought over from dev as the shared baseline

Not included

  • Wiki: skipped for now, nothing to document yet beyond the README

scr0ols and others added 11 commits July 17, 2026 19:49
Synced from dev as the baseline for the documentation pass.
Adapted from the SoundTweaks repo's structure and formatting, scoped to
StreamHive's single dev branch and Node/React stack.
Superseded by CONTRIBUTING.md, which GitHub renders as Markdown; the
extensionless copy displayed the raw source instead of formatted text.
Fix the Desktop OS example (iOS isn't a desktop OS), add labels and
StreamHive-specific environment fields (audio mode, grid size) to the
bug report template, and drop the empty custom issue template.
Covers what changed, conventional-commit type, target-branch warning
(dev only, never main), and a short pre-merge checklist.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds standard GitHub “community health” documentation to bring StreamHive in line with the Community Standards checklist ahead of launch, and establishes a baseline README for contributors.

Changes:

  • Adds CODE_OF_CONDUCT.md (Contributor Covenant) and SECURITY.md (private vulnerability reporting via GitHub).
  • Adds CONTRIBUTING.md plus GitHub issue templates and a pull request template.
  • Introduces/updates README.md as a shared baseline describing project intent, stack, and workflow.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
SECURITY.md Adds a security policy and directs reporters to private vulnerability reporting.
README.md Establishes a baseline project overview, stack, status, and branch workflow.
CONTRIBUTING.md Adds contribution guidelines, commit conventions, and local setup notes.
CODE_OF_CONDUCT.md Adds Contributor Covenant community standards and enforcement details.
.github/PULL_REQUEST_TEMPLATE.md Adds a PR template with change type, target branch reminder, and checklist.
.github/ISSUE_TEMPLATE/feature_request.md Adds a feature request issue template.
.github/ISSUE_TEMPLATE/bug_report.md Adds a bug report issue template with reproduction/environment prompts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md Outdated
Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated
Copilot AI and others added 2 commits July 17, 2026 19:28
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@scr0ols
scr0ols merged commit d4966e1 into main Jul 17, 2026
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.

3 participants