docs: add CONTRIBUTING for plugin authors#9
Merged
Conversation
Document the repo layout, the manifest schema, the CI gates (manifest validation, no binaries, code scan, gitleaks, CodeQL), the security expectations for plugin code, and the official-vs-community distinction, so contributors know the rules up front and reviewers have a shared reference. Refs Maik-0000FF/SpaceUX#426
…w-checked Close the two gaps from review: document that a theme plugin carries only the common manifest fields (its styling lives in its own files), and that the SPDX header is a convention enforced in review rather than by a CI gate. Refs Maik-0000FF/SpaceUX#426
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
1 participant
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.
What
Adds
CONTRIBUTING.mdfor the plugins repo, the process counterpart to the CI gates (Layer 1 of Maik-0000FF/SpaceUX#426).It documents:
function/theme/nav-style/shapefolders and what a plugin directory contains);manifest.jsonschema enforced byscripts/validate-plugins.mjs(required fields,kindmatching the folder, reverse-DNS unique id, semver, kind-specific payload);eval/Function, no obfuscation, minimal dependencies; the runtime capability model is in progress);Why
A shared, up-front reference makes the automated gates predictable for contributors and gives reviewers a consistent checklist.
Refs Maik-0000FF/SpaceUX#426