-
-
Notifications
You must be signed in to change notification settings - Fork 5
docs: refresh plugin READMEs and fix manifest bugs #92
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
11db5bb
docs: refresh plugin READMEs and fix manifest bugs
5d29ce4
docs: audit remaining plugin READMEs
b2f76c1
docs: fix plugin sub-docs (QUICK_START, STANDALONE, TESTING)
64ce9aa
Add CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, PR template
2f35c88
Add issue templates (plugin bug, plugin request)
0ac5ce1
docs: fix more bare /api/plugins paths
8d003ac
docs: flag hockey/lacrosse display_mode collision; add collision check
ee21a36
fix(text-display): align code default with schema default
7a76714
fix(manifests): repair version history across 11 plugins
c4bdadb
fix(manifests): conform to canonical schema and clean up deprecated f…
1076298
fix(plugin-deps): declare missing required Python packages
c657807
fix(registry): sync user-visible fields from manifests + fix author d…
e7cdc05
fix(licenses): add missing per-plugin LICENSE files
98d5478
docs: address CodeRabbit review comments on #92
52cd4b5
docs: address CodeRabbit follow-up comments on #92
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| name: Plugin bug report | ||
| about: Report a bug in one of the official plugins | ||
| title: '[<plugin-id>] ' | ||
| labels: bug | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| <!-- | ||
| Before filing: please check existing issues to see if this is already | ||
| reported. For security issues, see SECURITY.md and report privately. | ||
| For bugs in the LEDMatrix core (display controller, web interface, | ||
| plugin loader), report at: | ||
| https://github.com/ChuckBuilds/LEDMatrix/issues | ||
| --> | ||
|
|
||
| ## Plugin | ||
|
|
||
| - **Plugin id**: <!-- e.g. hockey-scoreboard --> | ||
| - **Plugin version** (from `manifest.json`): <!-- e.g. 1.2.4 --> | ||
| - **Installed via**: <!-- Plugin Store / Install from GitHub URL / manual copy --> | ||
|
|
||
| ## Describe the bug | ||
|
|
||
| <!-- A clear and concise description of what the bug is. --> | ||
|
|
||
| ## Steps to reproduce | ||
|
|
||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| ## Expected behavior | ||
|
|
||
| <!-- What you expected to happen. --> | ||
|
|
||
| ## Actual behavior | ||
|
|
||
| <!-- What actually happened. Include any error messages from the | ||
| LEDMatrix Logs tab or `journalctl -u ledmatrix`. --> | ||
|
|
||
| ## Plugin configuration | ||
|
|
||
| <!-- Paste the relevant section from config/config.json (redact any | ||
| API keys). The plugin's tab in the web UI shows the current config. --> | ||
|
|
||
| ```json | ||
| "<plugin-id>": { | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| ## Logs | ||
|
|
||
| <!-- Run: | ||
| sudo journalctl -u ledmatrix -n 100 --no-pager | grep <plugin-id> | ||
| or grab the relevant lines from the web UI's Logs tab. --> | ||
|
|
||
| ``` | ||
| ``` | ||
|
|
||
| ## Hardware | ||
|
|
||
| - **Raspberry Pi model**: <!-- e.g. Pi 4 4GB --> | ||
| - **LEDMatrix version**: <!-- git commit or release tag from the LEDMatrix repo --> | ||
| - **Display panels**: <!-- e.g. 2x 64x32 --> | ||
|
|
||
| ## Additional context | ||
|
|
||
| <!-- Anything else that might help: API key configured? External | ||
| service status? Anything that's different about your setup? --> | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| name: Plugin request | ||
| about: Suggest a new plugin or a feature for an existing one | ||
| title: '[Plugin request] ' | ||
| labels: enhancement | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| <!-- | ||
| Before filing: search existing issues to see if this has been suggested. | ||
| If you want to add a brand-new plugin yourself, see SUBMISSION.md | ||
| instead — that's the contributor flow, not an issue. | ||
| --> | ||
|
|
||
| ## Is this a new plugin or a feature for an existing plugin? | ||
|
|
||
| - [ ] Brand-new plugin | ||
| - [ ] Feature for an existing plugin: <!-- which one? --> | ||
|
|
||
| ## What does it display? | ||
|
|
||
| <!-- A short description of what should appear on the LED matrix and | ||
| what data source(s) it would use. Sketches or photos are very welcome. --> | ||
|
|
||
| ## Data source | ||
|
|
||
| <!-- Where does the data come from? An API? An RSS feed? A local file? | ||
| Does it require an API key? Is it free or paid? Are there rate limits? --> | ||
|
|
||
| - **Source**: | ||
| - **API key required?**: <!-- yes / no — and is the free tier enough? --> | ||
| - **Rate limits**: | ||
|
|
||
| ## Display modes | ||
|
|
||
| <!-- How many distinct screens / modes should the plugin have? E.g. a | ||
| sports plugin might have live / recent / upcoming. A clock might have | ||
| just one. --> | ||
|
|
||
| ## Why is this useful? | ||
|
|
||
| <!-- Who would use this and what makes it interesting on a tiny LED | ||
| display? Helps maintainers prioritize. --> | ||
|
|
||
| ## Are you offering to build it? | ||
|
|
||
| - [ ] Yes — see [SUBMISSION.md](../SUBMISSION.md) for the contributor flow | ||
| - [ ] No, just a suggestion | ||
| - [ ] Maybe, with some help | ||
|
|
||
| ## Similar plugins | ||
|
|
||
| <!-- Are there existing LEDMatrix plugins that are close to what you | ||
| want? (Browse the Plugin Manager tab in the web UI, or the plugins/ | ||
| directory in this repo.) Could the existing one be extended instead? --> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # Pull Request | ||
|
|
||
| ## Summary | ||
|
|
||
| <!-- 1-3 sentences describing what this PR does and why. --> | ||
|
|
||
| ## Type of change | ||
|
|
||
| <!-- Check all that apply. --> | ||
|
|
||
| - [ ] Bug fix in an existing plugin | ||
| - [ ] New plugin (also fill out the SUBMISSION.md checklist below) | ||
| - [ ] New feature for an existing plugin | ||
| - [ ] Documentation only | ||
| - [ ] Repo-wide change (registry script, hook, top-level docs) | ||
|
|
||
| ## Plugin(s) affected | ||
|
|
||
| <!-- List the plugin id(s) this PR touches, e.g. hockey-scoreboard, | ||
| ledmatrix-weather. Use "N/A" for repo-wide changes. --> | ||
|
|
||
| ## Related issues | ||
|
|
||
| <!-- "Fixes #123" or "Refs #123". Use "Fixes" for bug PRs. --> | ||
|
|
||
| ## Test plan | ||
|
|
||
| <!-- How did you test this? Check all that apply. Add details for any | ||
| checked box. --> | ||
|
|
||
| - [ ] Loaded the plugin in LEDMatrix on real hardware | ||
| - [ ] Loaded the plugin in LEDMatrix emulator mode | ||
| (`EMULATOR=true python3 run.py`) | ||
| - [ ] Rendered the plugin in the dev preview server | ||
| (`scripts/dev_server.py`) | ||
| - [ ] Verified the web UI configuration form against the schema | ||
| - [ ] N/A — repo-wide / docs-only change | ||
|
|
||
| ## Required for plugin changes | ||
|
|
||
| - [ ] **Bumped `version` in `plugins/<id>/manifest.json`** | ||
| (the Plugin Store uses version comparison to ship updates — | ||
| forgetting this means users won't receive the change) | ||
| - [ ] `class_name` in `manifest.json` matches the actual class in | ||
| `manager.py` exactly (case-sensitive, no spaces) | ||
| - [ ] `entry_point` matches the real file (or is omitted to use | ||
| the `manager.py` default) | ||
| - [ ] Updated the plugin's `README.md` if config keys changed | ||
| - [ ] `config_schema.json` is the source of truth for the web UI | ||
| form — any new option is in the schema with a `default`, | ||
| `description`, and constraints | ||
| - [ ] Pre-commit hook ran successfully (auto-syncs `plugins.json`) | ||
|
|
||
| ## SUBMISSION checklist (new plugins only) | ||
|
|
||
| <!-- See SUBMISSION.md for the full requirements. --> | ||
|
|
||
| - [ ] Plugin id matches the directory name and is unique | ||
| - [ ] `manifest.json` has all required fields (`id`, `name`, | ||
| `version`, `class_name`, `display_modes`) | ||
| - [ ] `manager.py` inherits from `BasePlugin` and implements | ||
| `update()` and `display()` | ||
| - [ ] `config_schema.json` exists and validates as JSON Schema Draft-7 | ||
| - [ ] `requirements.txt` lists all Python dependencies | ||
| - [ ] `README.md` documents what the plugin does, how to install, | ||
| and the configuration options | ||
| - [ ] `LICENSE` is GPL-3.0 (or compatible) | ||
| - [ ] No hardcoded API keys or secrets — secrets go in | ||
| `config/config_secrets.json` under the plugin id | ||
| - [ ] Tested on a real LEDMatrix setup (or in the emulator) | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] My commits follow the message convention in `CONTRIBUTING.md` | ||
| - [ ] I read `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` | ||
| - [ ] I've not committed any secrets | ||
|
|
||
| ## Notes for reviewer | ||
|
|
||
| <!-- Anything reviewers should know — gotchas, decisions you'd like | ||
| a second opinion on, things you weren't sure about. --> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| # 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, 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. | ||
| Examples of representing our community include using an official email address, | ||
| posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. | ||
|
|
||
| This includes the LEDMatrix Discord server, GitHub repositories owned by | ||
| ChuckBuilds, and any other forums hosted by or affiliated with the project. | ||
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement on the | ||
| [LEDMatrix Discord](https://discord.gg/uW36dVAtcT) (DM a moderator or | ||
| ChuckBuilds directly) or by opening a private GitHub Security Advisory if | ||
| the issue involves account safety. 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. | ||
|
|
||
| ## Enforcement Guidelines | ||
|
|
||
| Community leaders will follow these Community Impact Guidelines in determining | ||
| the consequences for any action they deem in violation of this Code of Conduct: | ||
|
|
||
| ### 1. Correction | ||
|
|
||
| **Community Impact**: Use of inappropriate language or other behavior deemed | ||
| unprofessional or unwelcome in the community. | ||
|
|
||
| **Consequence**: A private, written warning from community leaders, providing | ||
| clarity around the nature of the violation and an explanation of why the | ||
| behavior was inappropriate. A public apology may be requested. | ||
|
|
||
| ### 2. Warning | ||
|
|
||
| **Community Impact**: A violation through a single incident or series | ||
| of actions. | ||
|
|
||
| **Consequence**: A warning with consequences for continued behavior. No | ||
| interaction with the people involved, including unsolicited interaction with | ||
| those enforcing the Code of Conduct, for a specified period of time. This | ||
| includes avoiding interactions in community spaces as well as external channels | ||
| like social media. Violating these terms may lead to a temporary or | ||
| permanent ban. | ||
|
|
||
| ### 3. Temporary Ban | ||
|
|
||
| **Community Impact**: A serious violation of community standards, including | ||
| sustained inappropriate behavior. | ||
|
|
||
| **Consequence**: A temporary ban from any sort of interaction or public | ||
| communication with the community for a specified period of time. No public or | ||
| private interaction with the people involved, including unsolicited interaction | ||
| with those enforcing the Code of Conduct, is allowed during this period. | ||
| Violating these terms may lead to a permanent ban. | ||
|
|
||
| ### 4. Permanent Ban | ||
|
|
||
| **Community Impact**: Demonstrating a pattern of violation of community | ||
| standards, including sustained inappropriate behavior, harassment of an | ||
| individual, or aggression toward or disparagement of classes of individuals. | ||
|
|
||
| **Consequence**: A permanent ban from any sort of public interaction within | ||
| the community. | ||
|
|
||
| ## 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]. | ||
|
|
||
| Community Impact Guidelines were inspired by | ||
| [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
|
||
| For answers to common questions about this code of conduct, see the FAQ at | ||
| [https://www.contributor-covenant.org/faq][FAQ]. Translations are available | ||
| at [https://www.contributor-covenant.org/translations][translations]. | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
| [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
| [Mozilla CoC]: https://github.com/mozilla/diversity | ||
| [FAQ]: https://www.contributor-covenant.org/faq | ||
| [translations]: https://www.contributor-covenant.org/translations |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a language tag to the empty fenced logs block.
Line 60 uses a fenced code block without a language, which triggers markdownlint MD040. Use
text(orlog) to keep lint clean.Suggested patch
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 60-60: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents