Skip to content

docs: add community-health files (CONTRIBUTING, CoC, SUPPORT, issue templates)#635

Merged
DavidCozens merged 2 commits into
mainfrom
docs/community-health-files
Jul 20, 2026
Merged

docs: add community-health files (CONTRIBUTING, CoC, SUPPORT, issue templates)#635
DavidCozens merged 2 commits into
mainfrom
docs/community-health-files

Conversation

@DavidCozens

@DavidCozens DavidCozens commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Purpose

Implements #584 (S23.08, under epic #246): add the standard community-health
files reflecting the closed-to-external-code contribution model (PolyForm
Noncommercial 1.0.0 + commercial dual-licensing).

Change Description

  • CONTRIBUTING.md — states the closed model: Core (Core/) is closed to
    external code (dual-licensing needs clean copyright); Platform (Platform/)
    adapter contributions are arranged by getting in touch via the contact
    form
    , foreshadowing a future permissive inbound path without committing to
    a self-serve PR flow. Welcomes issues/bugs/discussion; points invited
    contributors at the existing in-repo workflow docs (CLAUDE.md,
    docs/local-checks.md, docs/NAMING.md) rather than duplicating them.
  • CODE_OF_CONDUCT.md — Contributor Covenant 2.1; enforcement contact via
    the cososo.co.uk contact form (no email published), matching SECURITY.md.
  • SUPPORT.md — minimal: docs → issues → security → commercial pointer.
  • .github/ISSUE_TEMPLATE/bug_report.yml and feature_request.yml
    YAML forms, plus config.yml disabling blank issues. Security reporting is
    steered to GitHub private advisories (preferred) with the cososo.co.uk form
    as fallback.

CHANGELOG.md is deliberately untouched — release-please owns it.
SECURITY.md already exists, so its community-profile checkmark is already lit.

Test Evidence

No code change — docs/config only. YAML issue forms validated as parseable.
Community-health files are picked up by GitHub's community-profile scanner.

Areas Affected

Repository root and .github/ISSUE_TEMPLATE/ only. No source, build, or CI
changes. Lights the Contributing and Code of conduct community-profile
checkmarks.

Closes #584

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added contributor guidance covering bug reports, feature requests, security concerns, support, and commercial enquiries.
    • Added a community Code of Conduct with standards and enforcement guidelines.
  • Issue Management

    • Introduced structured templates for bug reports and feature requests.
    • Added guidance links for security reporting, licensing, and paid support.
    • Disabled blank issue creation to encourage clearer, structured submissions.

…emplates)

Adds the standard community-health files reflecting the closed-to-external-code
contribution model (PolyForm Noncommercial + commercial dual-licensing):

- CONTRIBUTING.md: Core closed; Platform-adapter contributions arranged via the
  contact form (foreshadows a future permissive path); welcomes issues and
  discussion; points invited contributors at the in-repo workflow docs.
- CODE_OF_CONDUCT.md: Contributor Covenant 2.1, enforcement via the contact form.
- SUPPORT.md: docs -> issues -> security -> commercial pointer.
- .github/ISSUE_TEMPLATE/: bug report + feature request YAML forms and config.yml
  disabling blank issues, with GitHub-preferred security reporting.

Lights the Contributing and Code-of-conduct community-profile checkmarks
(Security already satisfied by SECURITY.md).

Closes #584

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Community health documentation and GitHub issue intake configuration are added, covering bug reports, feature requests, support, contribution boundaries, contact routing, and conduct enforcement.

Changes

Community health

Layer / File(s) Summary
Structured issue intake
.github/ISSUE_TEMPLATE/*
Bug and feature forms collect structured reports with required confirmations, while configuration disables blank issues and routes security and commercial enquiries.
Contribution and support guidance
CONTRIBUTING.md, SUPPORT.md
Contribution boundaries, repository references, support routes, security reporting, and commercial contact guidance are documented.
Code of Conduct
CODE_OF_CONDUCT.md
Contributor standards, scope, enforcement responsibilities, escalation, and attribution are defined.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the change set: community-health docs, templates, and issue guidance were added.
Description check ✅ Passed The PR description follows the required sections and covers purpose, changes, test evidence, and affected areas.
Linked Issues check ✅ Passed The changes satisfy #584 by adding the requested community-health files, templates, and contact/security guidance.
Out of Scope Changes check ✅ Passed No clear out-of-scope changes are evident; the diff stays within community-health documentation and issue templates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/community-health-files

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/config.yml:
- Around line 1-11: Add a dedicated questions/discussion contact route or issue
form to the contact_links configuration while keeping blank_issues_enabled set
to false, ensuring it matches the destination documented by CONTRIBUTING.md and
SUPPORT.md. If an existing documented destination is intended, update those
documents to reference the newly available route.

In `@CODE_OF_CONDUCT.md`:
- Around line 5-10: Update the adapted policy prose in CODE_OF_CONDUCT.md to use
UK spelling throughout, including colour, behaviour, apologising, and
sexualised, and apply the same normalization to the referenced sections. If any
upstream Covenant text must remain verbatim, explicitly mark that passage as an
intentional exception.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: bc8336c6-4b25-4bae-9a83-584f5fc82615

📥 Commits

Reviewing files that changed from the base of the PR and between 09372e7 and be00567.

📒 Files selected for processing (6)
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • SUPPORT.md

Comment thread .github/ISSUE_TEMPLATE/config.yml
Comment thread CODE_OF_CONDUCT.md
@github-actions

Copy link
Copy Markdown
Contributor

☀️   Quality Summary

   🚦   build-linux-gcc: 100% successful (✔️ 1524 passed)
   🚦   build-freertos-host-tdd-plustcp: 100% successful (✔️ 1876 passed)
   🚦   build-linux-clang: 100% successful (✔️ 1455 passed)
   🚦   sanitize-linux-gcc: 100% successful (✔️ 1455 passed)
   🚦   integration-linux-openssl: 100% successful (✔️ 16 passed)
   🚦   integration-linux-mbedtls: 100% successful (✔️ 14 passed)
   🚦   integration-windows-openssl: 100% successful (✔️ 16 passed)
   🚦   bdd-linux-syslog-ng: 94% successful (✔️ 49 passed, 🙈 3 skipped)
   🚦   bdd-windows-otel: 88% successful (✔️ 46 passed, 🙈 6 skipped)
   🚦   bdd-freertos-qemu-plustcp: 87% successful (✔️ 45 passed, 🙈 7 skipped)
   🚦   bdd-freertos-qemu-lwip: 87% successful (✔️ 45 passed, 🙈 7 skipped)
   🚦   build-windows-msvc: 100% successful (✔️ 1300 passed)
   🚦   build-linux-tunable-override: 100% successful (✔️ 1455 passed)
   ⚠️   Clang-Tidy: No warnings
   ⚠️   CPPCheck: No warnings


Created by Quality Monitor v1.14.0 (#f3859fd). More details are shown in the GitHub Checks Result.

Addresses CodeRabbit review on #635:

- Add .github/ISSUE_TEMPLATE/question.yml so "open an issue" for usage
  questions (promised in CONTRIBUTING.md and SUPPORT.md) has a route now that
  blank issues are disabled.
- Mark CODE_OF_CONDUCT.md as a verbatim reproduction of Contributor Covenant
  v2.1; the upstream US spelling is kept intentionally, documented as an
  explicit exception to the repo's UK-spelling convention.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

☀️   Quality Summary

   🚦   build-linux-gcc: 100% successful (✔️ 1524 passed)
   🚦   build-freertos-host-tdd-plustcp: 100% successful (✔️ 1876 passed)
   🚦   build-linux-clang: 100% successful (✔️ 1455 passed)
   🚦   sanitize-linux-gcc: 100% successful (✔️ 1455 passed)
   🚦   integration-linux-openssl: 100% successful (✔️ 16 passed)
   🚦   integration-linux-mbedtls: 100% successful (✔️ 14 passed)
   🚦   integration-windows-openssl: 100% successful (✔️ 16 passed)
   🚦   bdd-linux-syslog-ng: 94% successful (✔️ 49 passed, 🙈 3 skipped)
   🚦   bdd-windows-otel: 88% successful (✔️ 46 passed, 🙈 6 skipped)
   🚦   bdd-freertos-qemu-plustcp: 87% successful (✔️ 45 passed, 🙈 7 skipped)
   🚦   bdd-freertos-qemu-lwip: 87% successful (✔️ 45 passed, 🙈 7 skipped)
   🚦   build-windows-msvc: 100% successful (✔️ 1300 passed)
   🚦   build-linux-tunable-override: 100% successful (✔️ 1455 passed)
   ⚠️   Clang-Tidy: No warnings
   ⚠️   CPPCheck: No warnings


Created by Quality Monitor v1.14.0 (#f3859fd). More details are shown in the GitHub Checks Result.

@DavidCozens
DavidCozens merged commit 68701d5 into main Jul 20, 2026
29 checks passed
@DavidCozens
DavidCozens deleted the docs/community-health-files branch July 20, 2026 16:32
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.

S23.08: Community-health files (CONTRIBUTING, CODE_OF_CONDUCT, SUPPORT, templates, CHANGELOG)

1 participant