Standardise issue labels and add structured issue templates#2750
Open
Talie5in wants to merge 11 commits into
Open
Standardise issue labels and add structured issue templates#2750Talie5in wants to merge 11 commits into
Talie5in wants to merge 11 commits into
Conversation
Make " - Not platform specific" top item.
Make " - Not platform specific" top item
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR standardises the MeshCore issue labels and introduces structured issue templates for bug reports and feature requests.
The goal is to make issue triage easier, reduce duplicate reports, and provide consistent filtering by area, firmware variant, and platform.
An example of some issues can be viewed on my fork -> https://github.com/Talie5in/MeshCore/issues
What changed
Added structured issue templates
This PR adds:
The templates ask contributors to search existing issues first and confirm that the report relates to MeshCore, not MeshOS.
Added component selection
Bug reports and feature requests now include structured selections for:
Feature requests also include:
Added platform selection
Platform selection is intentionally limited to MCU family:
This avoids board-level label noise while still keeping useful triage information.
Label model
Labels are grouped by purpose:
Area labels
area:firmwarearea:clientarea:uiarea:toolingarea:hardwarearea:protocolarea:routingarea:documentationFirmware variant labels
firmware:communityfirmware:ripplePlatform labels
platform:esp32platform:nrf52Triage labels
needs-triageneeds-reviewneeds-infoType labels
bugenhancementColour grouping
Label colours are grouped intentionally to make the issue list easier to scan:
This creates visual grouping without needing to read every label individually.
You can view the labels and colours here on my fork -> https://github.com/Talie5in/MeshCore/labels
Existing label cleanup
The included label sync script renames existing labels where possible:
Firmware→area:firmwareMeshCore App→area:clientTDeck / Ripple GUI→area:uiNew Hardware Support→area:hardwaredocumentation→area:documentationThe
MeshOSlabel is removed, as MeshOS is now a separate project.Included label sync script
The script is idempotent and can be safely re-run. It creates missing labels, renames existing labels, and updates colours/descriptions.
Automation
This PR also includes
.github/workflows/auto-label-issues.yml.The workflow runs when an issue is opened or edited and automatically applies labels based on the structured issue form selections.
For example:
Firmware - Community→area:firmware,firmware:communityFirmware - Ripple→area:firmware,firmware:rippleClient - MeshCore App→area:clientUI - TDeck / Ripple GUI→area:uiCLI / Tooling→area:toolingNew Hardware Support→area:hardwareProtocol / Routing→area:protocol,area:routingDocumentation→area:documentationESP32→platform:esp32nRF52→platform:nrf52Unsure→needs-reviewAll new or edited issues also receive
needs-triage.This keeps labels consistent without relying on manual triage for the first pass.