Repository navigation
Write down the conventions plugins here share - #13
Conversation
One concern per plugin, built on the others through `dependencies`; little always-on context; one project layout (AGENTS.md, .claude/worktrees/); and the repository and release rules, now in one place. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Marius1311
left a comment
There was a problem hiding this comment.
Conventions needs a bit or revising to be appropriate for a lab's central place for plugins. If it was only my own plugins, it would be okay to say we have only one way of doing things, and plugins strictly build on each other, but with several people contributing, we need to adopt a bit.
| Plugins here are built to work together. A new plugin, and every change to one, follows these rules; anything they | ||
| don't cover is the plugin's own choice. | ||
|
|
||
| **One concern per plugin.** |
There was a problem hiding this comment.
I think that's overly strict. If we want this marketplace to become the central hub for quadbio plugins, we need to be open to alternative working styles, i.e. plugins that might mix analysis setup with another aim.
I agree with the other conventions below, just this one needs updating. As another example, someone might contribute an alternative euler-hpc skill, with a different recommended way of working. That's okay, we can accomodate different alternatives in the marketplace.
Later on, once we have more plugins, we could group them around common themes, to emphasize structure and organization.
There was a problem hiding this comment.
Agreed, fixed in a4db3c2. The block is now "Overlap and dependencies": overlapping and alternative plugins are welcome, and each one's README names the plugins it overlaps with and how it differs, so users can choose. What stays is for plugins that build on another: defer instead of restating, and declare dependencies when it needs the other to work. I dropped "one concern per plugin" and the trigger rule. Grouping by theme can come once the table grows.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Cu5AYoH46bk3rW3qivyPZ5
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a4db3c2fc9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| **One project layout**, so plugins agree on it: | ||
| - a repo's agent instructions live in one `AGENTS.md`, which Claude Code and Codex both read without settings; | ||
| - worktrees live in `.claude/worktrees/`, where `claude --worktree` creates them. |
There was a problem hiding this comment.
Ignore the in-repository worktree directory
For any plugin repository without an existing ignore rule, following this convention makes claude --worktree create a nested checkout that appears as an untracked .claude/worktrees/<name>/ tree in the main checkout, leaving git status dirty and making accidental staging possible. The official --worktree documentation explicitly says to add .claude/worktrees/ to .gitignore, so this shared layout convention should require that rule as well.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in 561ff56: the rule now says .gitignore lists .claude/worktrees/, and this repo gets that .gitignore. cell-type-annotation was the only plugin missing it; added in quadbio/cell-type-annotation#55.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Cu5AYoH46bk3rW3qivyPZ5
Adds a Conventions section to the README, so a new plugin can follow the rules before its PR rather than learn them in review (#12). Anything the section doesn't cover stays the plugin's own choice.
dependencies, which installs both (tested with a throwaway marketplace), and its Develop section says to load both.AGENTS.md(Claude Code and Codex both read it, docs) and.claude/worktrees/.claude plugin validate .,userConfigfor per-person values, and nothing private in public text.The four listed plugins pass
claude plugin validate.cell-type-annotationdeclares its dependencies in quadbio/cell-type-annotation#55.🤖 Generated with Claude Code
https://claude.ai/code/session_01Cu5AYoH46bk3rW3qivyPZ5