Skip to content

docs(contributing): clarify multi-plugin repository submissions - #585

Open
kantorcodes wants to merge 1 commit into
mainfrom
plugin-contrib/document-multi-bundle-submissions-20261026
Open

kantorcodes wants to merge 1 commit into
mainfrom
plugin-contrib/document-multi-bundle-submissions-20261026

Conversation

@kantorcodes

Copy link
Copy Markdown
Member

Documents the existing README-to-nested-manifest matching behavior for original contributors who maintain several installable Codex plugins in one repository. Responds to the concrete questions in issue #430 from redfox-data and pallgeuer. Covers per-bundle display names, root links, source-branch syntax, umbrella-entry ambiguity and unchanged centralized scanning/review requirements.

Only CONTRIBUTING.md changes. Reviewed the current source generator logic (scripts/generate_plugins_json.py); no runtime install test or independent reviewer approval is claimed. Drafted with AI assistance for maintainer review. This PR does not approve, merge or publish outside plugin submissions.

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can type 'qodo, fix this' on a finding and the fix lands right on your PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Clarify submissions from repositories with multiple plugins

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Explain how to list independently installable plugins from one repository using manifest-matched
 README names.
• Clarify source-branch URLs, umbrella-entry ambiguity, and the unchanged scanning and review
 requirements.
Diagram

graph TD
  Guide["Contribution guide"] --> Entries["README entries"] --> Generator["Catalog generator"] --> Archive["Source archive"] --> Manifests["Nested manifests"] --> Bundles["Mirrored bundles"] --> Catalog["Catalog outputs"]
Loading
High-Level Assessment

Documenting the existing README-to-manifest behavior is appropriate for this clarification. Automatically discovering entries from a source marketplace would change catalog behavior and expand the scope beyond the reported contributor questions.

Files changed (1) +8 / -0

Documentation (1) +8 / -0
CONTRIBUTING.mdDocument submissions from multi-plugin repositories +8/-0

Document submissions from multi-plugin repositories

• Adds guidance for naming and alphabetizing one README entry per installable bundle, explains how the generator matches nested manifests, and warns against ambiguous umbrella entries and bundle paths appended to branch URLs. Reiterates that each bundle remains subject to manifest, centralized scan, check, and independent review requirements.

CONTRIBUTING.md

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant