Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Everything is owned by the maintainer.
* @MichaelAdamGroberman
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
25 changes: 25 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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/).