mirror of
https://github.com/Colorado-Mesh/meshcore-bot-firmware.git
synced 2026-08-11 16:20:29 +00:00
Add repo scaffolding for Colorado-Mesh publish
Adds the project metadata and CI/release workflow needed to publish this repo under Colorado-Mesh/meshcore-bot-firmware. - LICENSE: MIT with attribution to upstream MeshCore (also MIT) - README: rewritten with badges, supported boards, install paths (web flasher / PlatformIO / esptool), bot command table, layout map, development quickstart - CONTRIBUTING: submodule + patch-queue workflow, what-goes-where, patch hygiene rules, PR expectations - RELEASE: cmesh-bot-vX.Y.Z tag scheme + procedure - CHANGELOG: Keep-a-Changelog format, seeded with the hop-coordination fix and patch-5 utility commands - Issue templates: bug_report (with bot stats prompt), feature_request, config.yml (no blank issues, link to upstream + community) - Pull request template: layer checklist, verification gates, prefs-schema impact prompt - .github/workflows/firmware-build.yml: keep PR check on representative envs (Heltec V3, RAK 4631 USB+BLE), add concurrency cancellation for PRs, scope cache key to PIO config hash - .github/workflows/release.yml: NEW; triggers on cmesh-bot-v* tag or manual dispatch, enumerates all 133 *_companion_radio_(usb|ble) envs from vendor/MeshCore/variants/, shards across 8 parallel matrix jobs, aggregates artifacts into a single draft release - scripts/verify.sh: respect MESHCORE_SKIP_APPLY_PATCHES like build-representative.sh does, so verify works when vendor already has patches applied as commits - .gitignore: add .forge.bak.*/ for forge backup directories
This commit is contained in:
61
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
61
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
name: Bug report
|
||||
description: Something's broken in the firmware or tooling
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for the report. The more concrete, the faster we can chase it down.
|
||||
- type: input
|
||||
id: firmware_version
|
||||
attributes:
|
||||
label: Firmware version
|
||||
description: From `bot` (no args) CLI command, the `version` chat command, or the filename you flashed.
|
||||
placeholder: cmesh-bot-v1.2.3-abc1234
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: board
|
||||
attributes:
|
||||
label: Board
|
||||
description: Which PlatformIO env / hardware?
|
||||
options:
|
||||
- Heltec V3 (USB)
|
||||
- Heltec V3 (BLE)
|
||||
- RAK 4631 (USB)
|
||||
- RAK 4631 (BLE)
|
||||
- LilyGo T-Echo
|
||||
- LilyGo T-Deck
|
||||
- Xiao S3 WIO
|
||||
- Other (specify below)
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: symptom
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: What did you observe? What did you expect instead?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: repro
|
||||
attributes:
|
||||
label: Reproduction steps
|
||||
description: The shortest sequence of actions that reproduces the bug.
|
||||
placeholder: |
|
||||
1. Flash cmesh-bot-vX.Y.Z to Heltec V3
|
||||
2. From another node 3 hops away, send `ping` on #bot
|
||||
3. Observe: no reply within 30s
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: bot_stats
|
||||
attributes:
|
||||
label: bot stats output (if available)
|
||||
description: Output of `bot` and `bot stats` from the USB CLI rescue console, before and after the trigger.
|
||||
render: shell
|
||||
- type: textarea
|
||||
id: other
|
||||
attributes:
|
||||
label: Anything else?
|
||||
description: Logs, screenshots, hop diagrams, peer node names, etc.
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: MeshCore upstream
|
||||
url: https://github.com/meshcore-dev/MeshCore/issues
|
||||
about: Bugs that affect upstream MeshCore (not specific to the Colorado bot patches) should go upstream.
|
||||
- name: Colorado Mesh community
|
||||
url: https://github.com/Colorado-Mesh
|
||||
about: General questions about Colorado Mesh — coverage, joining, hardware recommendations.
|
||||
28
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
28
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
name: Feature request
|
||||
description: Suggest a new bot command, board, or capability
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: textarea
|
||||
id: motivation
|
||||
attributes:
|
||||
label: What problem are you trying to solve?
|
||||
description: Start with the use case, not the proposed solution.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: proposal
|
||||
attributes:
|
||||
label: Proposal
|
||||
description: What command, behavior, or board support would address the problem?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives you've considered
|
||||
description: Other commands, workflow changes, off-device tools, etc.
|
||||
- type: textarea
|
||||
id: scope
|
||||
attributes:
|
||||
label: Anything specific about scope or implementation?
|
||||
description: e.g. should this be guarded by a CLI toggle? Does it need new bot prefs? Cross-bot coordination?
|
||||
Reference in New Issue
Block a user