From 4c16a941750924152cecbce46e442804b12b84fa Mon Sep 17 00:00:00 2001 From: Michael Adam Groberman <81723568+MichaelAdamGroberman@users.noreply.github.com> Date: Thu, 4 Jun 2026 00:54:05 -0400 Subject: [PATCH] chore: add community-health files Add CODE_OF_CONDUCT, CODEOWNERS, issue/PR templates, and dependabot config. Templates frame the project as a maker reference implementation (bugs best-effort, features "fork it"). --- .github/CODEOWNERS | 2 ++ .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 25 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++ .github/dependabot.yml | 6 ++++ CODE_OF_CONDUCT.md | 25 +++++++++++++++ 6 files changed, 110 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/dependabot.yml create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..7fac38f --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# Everything is owned by the maintainer. +* @MichaelAdamGroberman diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..c9e2f0b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Something in the firmware or tooling doesn't work as documented +title: '' +labels: bug +assignees: '' +--- + +> **Heads up:** this is a reference implementation, not a supported product. +> Bug reports are welcome, but fixes land on a best-effort basis. If you need a +> behavior change for your own build, forking is encouraged. + +## What happened + +A clear description of the bug. + +## What you expected + +What you thought would happen instead. + +## Steps to reproduce + +1. +2. +3. + +## Environment + +- Board: (e.g. M5StickC Plus) +- PlatformIO version: +- Host OS: +- Transport: (USB serial / BLE / WiFi LAN / WiFi + WireGuard) + +## Logs / screenshots + +Paste any serial output or photos that help. Scrub secrets, tokens, and +private IPs first. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..03d3196 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,25 @@ +--- +name: Feature request +about: Suggest an idea (but the answer is probably "fork it") +title: '' +labels: wontfix +assignees: '' +--- + +> **Heads up:** this is a reference implementation for makers, not a roadmap. +> New features generally won't be added upstream — the whole point is that you +> take this code and build your own thing. If you have an idea, **fork it and +> make it real.** That said, if you think something is broadly useful, open an +> issue and let's talk. + +## The idea + +What would you like to see? + +## Why + +What does it enable for your build? + +## Are you forking? + +If you're building this yourself, link your fork — happy to point people at it. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..5d2b33c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +## What this does + +Briefly describe the change. + +## Type + +- [ ] Fix (corrects broken or undocumented behavior) +- [ ] Docs (README, comments, examples) +- [ ] Other (please describe) + +## Checklist + +- [ ] I read [CONTRIBUTING.md](../CONTRIBUTING.md) +- [ ] Firmware still builds (`pio run`) +- [ ] No secrets, tokens, private IPs, or local file paths in the diff diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..ca79ca5 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + schedule: + interval: weekly diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6b877ff --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,25 @@ +# Code of Conduct + +This is a small reference-implementation project. The rule is simple: **be +decent.** + +- Be respectful and constructive. Critique ideas, not people. +- No harassment, personal attacks, discrimination, or sexualized language. +- Assume good faith. Most disagreements are misunderstandings. +- Keep it on-topic: this is a maker/firmware project, not a soapbox. + +Maintainers may edit, hide, or remove comments, commits, issues, and PRs that +violate these expectations, and may block repeat offenders. + +## Reporting + +If someone is being a problem, reach out privately: + +- Email: michael.groberman@icloud.com +- LinkedIn: https://www.linkedin.com/in/michael-adam-groberman/ + +Reports are handled discreetly. + +--- + +Adapted in spirit from the [Contributor Covenant](https://www.contributor-covenant.org/).