Skip to content

Write down the conventions plugins here share - #13

Merged
Marius1311 merged 3 commits into
mainfrom
docs/conventions
Oct 14, 2026
Merged

Marius1311 merged 3 commits into
mainfrom
docs/conventions

Conversation

@Marius1311

@Marius1311 Marius1311 commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

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.

  • Overlap and dependencies. Overlapping and alternative plugins are welcome, and each one's README says how it differs from the plugins it overlaps with. A plugin that builds on another defers to it rather than restating it. One that needs another to work declares it in dependencies, which installs both (tested with a throwaway marketplace), and its Develop section says to load both.
  • Little always-on context. Rules go in skills. Hooks only for what must hold in every session, since their output adds up across installed plugins.
  • One project layout. AGENTS.md (Claude Code and Codex both read it, docs) and .claude/worktrees/.
  • Repository and release. The README layout and version-bump releases, moved here from the closing paragraph, plus claude plugin validate ., userConfig for per-person values, and nothing private in public text.

The four listed plugins pass claude plugin validate. cell-type-annotation declares its dependencies in quadbio/cell-type-annotation#55.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Cu5AYoH46bk3rW3qivyPZ5

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>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-13T18:47:44.996509Z a4db3c2 New commits
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@Marius1311 Marius1311 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
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.**

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread README.md Outdated

**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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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