contribute

Guide for contributing to Trellis documentation and marketplace. Covers adding spec templates, marketplace skills, documentation pages, and submitting PRs across both the Trellis main repo and docs repo. Use when someone wants to add a new spec template, add a new skill to the marketplace, add or update documentation pages, or submit a PR to this project.

Quality

87%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Quality

Content

85%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A highly actionable, well-sequenced contributor guide with concrete code, exact paths, and genuine validation checkpoints (pnpm verify, pre-commit hooks, PR checklist). Its main weaknesses are moderate repetition across sections and a monolithic single-file structure that inlines content better suited to separate reference files.

Suggestions

Split stable reference material into references/ files (e.g., references/docs-json-structure.md, references/mdx-components.md, references/dev-setup.md) and keep SKILL.md as a lean overview with one-level-deep pointers.

Remove the repeated per-section 'update docs.json navigation' instructions by stating the pattern once (e.g., a short 'Navigation updates' section) and referencing it from each workflow.

Trim the 'Contributing Documentation' section, which restates steps already covered by the earlier workflow sections, and mention showcase/blog triggers in the description since the body covers them.

Dimension	Reasoning	Score
Conciseness	The body is mostly lean: directory trees, exact paths, JSON/bash snippets, and tables with almost no re-teaching of concepts Claude already knows. A 4 rather than 5 because of repeated per-section 'update docs.json navigation' instructions and the 'Contributing Documentation' section restating patterns already covered.	4 / 5
Actionability	Registration JSON templates, MDX frontmatter templates, exact EN/ZH file paths, copy-paste 'cp' and 'npx skills add' commands, and concrete PR steps cover all common contribution cases. Fully executable with no pseudocode.	5 / 5
Workflow Clarity	Each contribution type has a numbered sequence, and validation is explicit: 'Test: pnpm dev', 'pnpm verify', 'pnpm lint:md', a husky pre-commit verify-docs.py hook as a feedback loop, and a 'Checklist Before PR'. These are multi-file batch edits, and validation checkpoints are present throughout, so the score holds at 5.	5 / 5
Progressive Disclosure	No references/, scripts/, or assets/ exist — the entire ~415-line skill is one file. Section headers are clear, but separable material (docs.json structure reference, MDX components, per-type contribution workflows, bilingual table) is inlined rather than offloaded to one-level-deep reference files, matching the 'content that should be separate is inline' anchor.	3 / 5
	Total	17 / 20 Passed

Description

83%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description: it states concrete capabilities in third person, names both target repos, and provides an explicit multi-trigger 'Use when' clause. The only gaps are minor coverage omissions (showcase, blog) and a few missing natural synonyms.

Dimension	Reasoning	Score
Specificity	"Covers adding spec templates, marketplace skills, documentation pages, and submitting PRs across both the Trellis main repo and docs repo" names several specific actions with named repos. It stays at 4 rather than 5 because the body also covers showcase projects and blog posts, which the description omits.	4 / 5
Completeness	Clearly answers both: what ("Guide for contributing to Trellis documentation and marketplace... submitting PRs across both repos") and when ("Use when someone wants to add a new spec template, add a new skill to the marketplace, add or update documentation pages, or submit a PR to this project"). Explicit trigger phrases match the 5 anchor; a 4 would have a weaker, less specific 'when'.	5 / 5
Trigger Term Quality	"add a new spec template", "add a new skill to the marketplace", "add or update documentation pages", "submit a PR" are phrases a user would naturally say. Not 5: missing common variations such as "contribute", "write a blog post", or "showcase my project" that the body also supports.	4 / 5
Distinctiveness Conflict Risk	Anchored to the specific Trellis project and its marketplace with distinct triggers; mostly distinguishable from other skills. Not 5 because "submit a PR to this project" and generic documentation wording carry minor overlap risk with general git/PR helper skills.	4 / 5
	Total	17 / 20 Passed

Validation

100%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: mindfold-ai/Trellis
Path: .claude/skills/contribute/SKILL.md
Commit: f089cb3

Reviewed: 3 days ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.