Skip to content

Document suite grouping in the modules-list convention #343

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.

Sign up for GitHub

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
mbastian merged 1 commit into from
Sep 20, 2026
Merged

Document suite grouping in the modules-list convention #343

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,32 @@ A disabled entry comments out all four lines:
<!-- <module>modules/LinkfluencePlugin</module> -->
```

**Suites** (a plugin split across multiple `modules/` folders — API/Impl/UI, or a bundled dependency
like the streaming plugin's `JettyWrapper`) share one origin and one status, so don't repeat the same
three comments once per folder. Precede the whole run of `<module>` lines with a single block
instead, using the suite's main module for `name` — the one module in the group whose `manifest.mf`
does *not* set `AutoUpdate-Show-In-Client: false`. That flag is how the other modules (API, Impl,
UI, or a bundled library) mark themselves as implementation details hidden from Gephi's plugin
manager, so its absence is what identifies the module the suite is actually known as:

```xml
<!-- name: Graph Streaming -->
<!-- origin: fork (panisson/gephi-plugins) -->
<!-- status: active -->
<module>modules/GraphStreaming</module>
<module>modules/DesktopStreaming</module>
<module>modules/StreamingAPI</module>
<module>modules/StreamingImpl</module>
<module>modules/JettyWrapper</module>
<module>modules/StreamingServer</module>
```

Only group modules that share **both** the same origin and the same status — two folders from the
same fork owner but a different PR are two separate plugin submissions, not a suite, and keep their
own three-comment block each. If one module in an otherwise-grouped suite is later disabled while its
siblings stay active, split it back out into its own block rather than forcing a mismatched status
into the shared one.

Update these comments whenever a plugin's status or origin changes — disabling or re-enabling it,
or adopting an unresponsive contributor's plugin onto a branch — don't leave them describing a
stale state.
Loading