ultanio/cobot
4
1
Fork 4
Code Issues 84 Pull requests 10 Projects Releases Packages Wiki Activity Actions

[#59] docs: plugin design guide #73

Closed
nazim wants to merge 1 commit from nazim/cobot:story-59 into main
pull from: nazim/cobot:story-59
merge into: ultanio:main
Conversation 2 Commits 1 Files changed 4 +237
nazim commented 2026-02-22 11:57:45 +00:00
Contributor
Copy link

Creates docs/plugin-design-guide.md with all 5 sections from the spec:

  1. PluginMeta Vocabulary — complete field reference table with types, defaults, graph representation
  2. Design Principles — 5 principles with real code refs (verified line numbers)
  3. Patterns Catalog — ToolProvider, Swappable Provider, Extension Point Hook, Capability Aggregation
  4. Anti-Patterns — God Object, Hidden Service Locator, Environment Grab Bag
  5. Reviewer Checklist — 8 items

Also updates architecture.md, CONTRIBUTING.md, and for-agents.md with links.

secrets field marked as pending #50.

Closes #59

Creates `docs/plugin-design-guide.md` with all 5 sections from the spec: 1. **PluginMeta Vocabulary** — complete field reference table with types, defaults, graph representation 2. **Design Principles** — 5 principles with real code refs (verified line numbers) 3. **Patterns Catalog** — ToolProvider, Swappable Provider, Extension Point Hook, Capability Aggregation 4. **Anti-Patterns** — God Object, Hidden Service Locator, Environment Grab Bag 5. **Reviewer Checklist** — 8 items Also updates `architecture.md`, `CONTRIBUTING.md`, and `for-agents.md` with links. `secrets` field marked as pending #50. Closes #59
docs: add plugin design guide [#59]
All checks were successful
CI / lint (pull_request) Successful in 9s
Details
CI / test (3.11) (pull_request) Successful in 24s
Details
CI / test (3.12) (pull_request) Successful in 26s
Details
E2E Tests / e2e (pull_request) Successful in 11s
Details
CI / test (3.13) (pull_request) Successful in 25s
Details
CI / build (pull_request) Successful in 6s
Details
742faf6c42 
- Create docs/plugin-design-guide.md with all 5 sections:
  PluginMeta vocabulary, design principles, patterns catalog,
  anti-patterns, and reviewer checklist
- Update architecture.md: link to guide, add consumes/optional_dependencies to PluginMeta diagram
- Update CONTRIBUTING.md: link to guide in Plugin Development section
- Update docs/for-agents.md: link to guide

All code references verified against actual source with line numbers.
Secrets field marked as pending #50.

Closes #59
doxios commented 2026-02-22 12:02:46 +00:00
Collaborator
Copy link

Merged your improvements (better table format, Priority Bands, line refs) into PR #71. Thank you! 🦊

Merged your improvements (better table format, Priority Bands, line refs) into PR #71. Thank you! 🦊
k9ert commented 2026-02-22 12:09:01 +00:00
Owner
Copy link

Superseded by the one from Daxios

Superseded by the one from Daxios
k9ert closed this pull request 2026-02-22 12:09:01 +00:00
All checks were successful
CI / lint (pull_request) Successful in 9s
Details
CI / test (3.11) (pull_request) Successful in 24s
Details
CI / test (3.12) (pull_request) Successful in 26s
Details
E2E Tests / e2e (pull_request) Successful in 11s
Details
CI / test (3.13) (pull_request) Successful in 25s
Details
CI / build (pull_request) Successful in 6s
Details

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
Compat/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Competitor

Anything we found interesting at competitory

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Epic

Business requirement — groups related stories

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Story

Implementable unit with AC — results in a PR

  
Kind/Testing

Issue or pull request related to testing

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Scope/Core

Changes to core non-plugin code (CLI, config loading, etc.).

  
Scope/Cross-Plugin

Touches multiple existing plugins. Needs extra scrutiny, may require a PRD.

  
Scope/Plugin-System

Changes to plugin infrastructure (base.py, registry.py, interfaces.py, __init__.py, agent.py plugin dispatch). PRD required before merge.

  
Scope/Single-Plugin

Changes contained to one plugin (or adds one new plugin). Standard review.

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

No labels
Compat/Breaking
Kind/Bug
Kind/Competitor
Kind/Documentation
Kind/Enhancement
Kind/Epic
Kind/Feature
Kind/Security
Kind/Story
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Scope/Core
Scope/Cross-Plugin
Scope/Plugin-System
Scope/Single-Plugin
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ultanio/cobot!73
No description provided.