← Back to issue list

Create a plugin template and docs for how to write a plugin

View original Github issue

Metadata

Project
craft-parts
Number
#888
Type
issue
State
open
Author
lengau
Labels
—
Created
Updated
Closed
—

Current evaluation

Feature request to add a plugin template and docs for writing Craft Parts plugins. The docs were delivered: create_plugin.rst how-to (PR #928) and document-plugin.rst template, both shipped in the docs index.

Suggested action: close resolved

Reason: The requested documentation now exists in the tree: commit 53eb1b33 ("doc: create new how-to on creating a plugin (#928)") added docs/how-to/create_plugin.rst, later refined by 022d23cb (#1349), and both are published via the "Create a plugin <create_plugin>" entry in docs/how-to/index.rst. The "template" half of the request is covered by docs/how-to/document-plugin.rst (labelled how_to_document_a_plugin), a placeholder-substitution template that is cross-linked from the end of the create-plugin how-to and from docs/reference/plugins.rst. The how-to also embeds a complete worked example plugin inline, so no separate scaffold file was needed — I confirmed craft_parts/plugins/new_dump_plugin.py was never committed, consistent with the doc telling readers to create it themselves.

Evaluated by: mr-cal-bot

Impact: 38 Quick Win: 14 Complexity: 45 Confidence: 88 Actionability: 65

Issue body

### What needs to get done Something like this: https://docs.openvino.ai/2024/documentation/openvino-extensibility/openvino-plugin-library.html ### Why it needs to get done Creating a plugin is hard for new users

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 38
Quick Win: 14
Complexity: 45
Confidence: 88
Actionability: 65
close resolved Feature request to add a plugin template and docs for writing Craft Parts plugins. The docs were delivered: create_plugin.rst how-to (PR #928) and document-plugin.rst template, both shipped in the docs index.
qwen/qwen3.6-35b-a3b
Impact: 60
Quick Win: 29
Complexity: 30
Confidence: 75
Actionability: 70
needs triage Request to create plugin template and documentation for writing custom plugins. Open for 695 days with no comments, labels, or maintainer response.
qwen/qwen3.8-27b
Impact: 45
Quick Win: 27
Staleness: 75
Complexity: 40
Confidence: 80
Support Request: 10
close stale Request for a plugin template and docs on writing a plugin. The how-to guide (docs/how-to/create_plugin.rst) was added in PR #928 and a documentation template (docs/how-to/document-plugin.rst) exists, so the core work appears done. Issue is 674 days old with no comments or labels.
qwen/qwen3.6-35b-a3b
Staleness: 95
Complexity: 40
Confidence: 90
Support Request: 10
needs triage Request to create a plugin template and documentation to simplify plugin development for new users. Unlabeled, no maintainer comments, inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 92
Complexity: 30
Confidence: 85
Support Request: 10
needs triage Request to create a plugin template and documentation to simplify plugin development for new users. Open with no comments, labels, or maintainer response in over 16 months.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: craft-parts#928 (confidence 92%)

    Commit 53eb1b33 'doc: create new how-to on creating a plugin (#928)' created docs/how-to/create_plugin.rst, the primary deliverable.

  • Related To: craft-parts#1349 (confidence 85%)

    Commit 022d23cb 'docs: normalise plugin references (#1349)' later normalised references in create_plugin.rst and document-plugin.rst.

Related issues

No related issues found above the similarity threshold.