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
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Bug report
description: Report something that does not work as expected.
title: "[Bug]: "
labels: ["bug"]
body:
- type: dropdown
id: area
attributes:
label: Area
description: Which part of Budpy is affected?
options:
- Web app (layout editor / provisioning)
- Firmware (ESP32 device)
- A specific plugin
- Documentation
- Other / not sure
validations:
required: true
- type: input
id: plugin
attributes:
label: Plugin
description: If a specific plugin is affected, which one?
placeholder: e.g. clock, weather, ha-sensor
- type: textarea
id: what-happened
attributes:
label: What happened?
description: A clear description of the bug.
placeholder: What did you see?
validations:
required: true
- type: textarea
id: expected
attributes:
label: What did you expect to happen?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
placeholder: |
1. Open the web app
2. Add a plugin ...
3. Send the config to the ESP32 ...
validations:
required: true
- type: input
id: version
attributes:
label: Budpy version
description: Version shown in the web app footer, or firmware version flashed on the device.
placeholder: e.g. 1.2.0
- type: input
id: device
attributes:
label: Device
description: For firmware issues, which board are you using?
placeholder: e.g. ESP32-2432S028R (CYD)
- type: input
id: browser
attributes:
label: Browser
description: For web app issues (Web Serial requires Chrome or Edge).
placeholder: e.g. Chrome 130 on macOS
- type: textarea
id: logs
attributes:
label: Logs / screenshots
description: Serial monitor output, browser console errors, or screenshots.
render: shell
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question or discussion
url: https://github.com/pyxel-dev/budpy/discussions
about: Ask questions and discuss ideas with the community.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest an improvement or new capability for Budpy.
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: textarea
id: problem
attributes:
label: What problem does this solve?
description: Describe the need or frustration behind the request.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed solution
description: What would you like to happen?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Other approaches or workarounds you have thought about.
- type: textarea
id: context
attributes:
label: Additional context
description: Mockups, links, or examples from other projects.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/plugin_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Plugin request
description: Suggest a new plugin (widget) for the Budpy dashboard.
title: "[Plugin]: "
labels: ["enhancement", "plugin"]
body:
- type: input
id: name
attributes:
label: Plugin name
placeholder: e.g. Calendar, Stock ticker, Air quality
validations:
required: true
- type: textarea
id: description
attributes:
label: What should it display?
description: Describe the information shown on the screen and how it should look.
validations:
required: true
- type: textarea
id: data-source
attributes:
label: Data source
description: Where does the data come from? (public API, Home Assistant entity, device-local, ...) Include API links if relevant.
validations:
required: true
- type: dropdown
id: contribution
attributes:
label: Are you willing to implement it?
description: Plugins are self-contained — see docs/plugins.md for the guide.
options:
- Yes, I plan to open a PR
- Maybe, with some guidance
- No, just suggesting the idea
validations:
required: true
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Description

<!-- What does this PR change, and why? -->

## Related issue

<!-- Link the issue this PR addresses, e.g. "Closes #12". Delete if none. -->

## Type of change

<!-- Check all that apply. -->

- [ ] Bug fix
- [ ] New feature
- [ ] New plugin
- [ ] Documentation
- [ ] Refactoring / maintenance

## How was this tested?

<!-- Describe what you ran and, for firmware changes, whether you tested on a real ESP32 CYD. -->

## Checklist

- [ ] `pnpm test` passes
- [ ] `pnpm typecheck` passes
- [ ] `pnpm generate:plugins` was run and the generated files are committed (if plugins/manifests changed)
- [ ] `pnpm firmware:build` compiles (if firmware or plugins changed)
- [ ] Tested on a physical device (if firmware behavior changed)
- [ ] Documentation updated (if needed, e.g. `docs/plugins.md`)
60 changes: 60 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: CI

on:
pull_request:
push:
branches:
- develop

permissions:
contents: read

jobs:
web:
name: Web app & SDK
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: pnpm/action-setup@v4
with:
run_install: false

- uses: actions/setup-node@v4
with:
node-version: 24

- run: pnpm install --frozen-lockfile

- name: Check generated plugin registry is up to date
run: |
pnpm generate:plugins
git diff --exit-code plugins/generated firmware/include/generated firmware/src/generated firmware/generated

- run: pnpm typecheck
- run: pnpm test
- run: pnpm build

firmware:
name: Firmware
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: pnpm/action-setup@v4
with:
run_install: false

- uses: actions/setup-node@v4
with:
node-version: 24

- uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Install PlatformIO CLI
run: python -m pip install --upgrade pip platformio

- run: pnpm install --frozen-lockfile
- run: pnpm firmware:build
73 changes: 73 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances
of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for
moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the project maintainer through
[pyxel.dev](https://pyxel.dev) or by opening a private report on GitHub.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
Loading
Loading