home / skills / jeremylongshore / claude-code-plugins-plus-skills / contributing-guide-creator

contributing-guide-creator skill

/skills/17-technical-docs/contributing-guide-creator

This skill helps automate contributing guide creation by providing step-by-step guidance, best practices, and production-ready configurations for technical

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill contributing-guide-creator

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.3 KB
---
name: "contributing-guide-creator"
description: |
  Create contributing guide creator operations. Auto-activating skill for Technical Documentation.
  Triggers on: contributing guide creator, contributing guide creator
  Part of the Technical Documentation skill category. Use when working with contributing guide creator functionality. Trigger with phrases like "contributing guide creator", "contributing creator", "contributing".
allowed-tools: "Read, Write, Edit, Bash(cmd:*), Grep"
version: 1.0.0
license: MIT
author: "Jeremy Longshore <[email protected]>"
---

# Contributing Guide Creator

## Overview

This skill provides automated assistance for contributing guide creator tasks within the Technical Documentation domain.

## When to Use

This skill activates automatically when you:
- Mention "contributing guide creator" in your request
- Ask about contributing guide creator patterns or best practices
- Need help with technical documentation skills covering api docs, user guides, architecture docs, and documentation automation.

## Instructions

1. Provides step-by-step guidance for contributing guide creator
2. Follows industry best practices and patterns
3. Generates production-ready code and configurations
4. Validates outputs against common standards

## Examples

**Example: Basic Usage**
Request: "Help me with contributing guide creator"
Result: Provides step-by-step guidance and generates appropriate configurations


## Prerequisites

- Relevant development environment configured
- Access to necessary tools and services
- Basic understanding of technical documentation concepts


## Output

- Generated configurations and code
- Best practice recommendations
- Validation results


## Error Handling

| Error | Cause | Solution |
|-------|-------|----------|
| Configuration invalid | Missing required fields | Check documentation for required parameters |
| Tool not found | Dependency not installed | Install required tools per prerequisites |
| Permission denied | Insufficient access | Verify credentials and permissions |


## Resources

- Official documentation for related tools
- Best practices guides
- Community examples and tutorials

## Related Skills

Part of the **Technical Documentation** skill category.
Tags: documentation, markdown, api-docs, readme, technical-writing

Overview

This skill automates creation of CONTRIBUTING guides and related operations for technical documentation. It produces step-by-step guidance, ready-to-use CONTRIBUTING.md content, and configuration snippets to enforce contribution workflows. The skill is auto-activated for contributing guide creator triggers and is tuned for developer and open-source workflows.

How this skill works

It analyzes requested contribution patterns and repository context, then generates a clear CONTRIBUTING.md, templates (issue/PR), code snippets, and CI validation steps. The skill follows common standards (commit message formats, branching, review rules) and validates outputs against practical checks like required sections, required fields, and actionable steps. It can also output automation configurations to enforce guidelines in CI or bot workflows.

When to use it

  • Creating a new CONTRIBUTING.md for an open-source or internal repo
  • Standardizing contribution processes across a mono-repo or plugin marketplace
  • Onboarding new contributors with clear PR, issue, and testing guidelines
  • Adding automation or CI checks to enforce contribution rules
  • Generating templates for issues, PRs, and code of conduct sections

Best practices

  • Include clear sections: scope, getting started, code style, tests, and review process
  • Provide minimal reproducible examples and a checklist for PRs
  • Add machine-enforceable rules: templates, CI checks, and required labels
  • Document branching and release/versioning policies explicitly
  • Pair CONTRIBUTING.md with CODE_OF_CONDUCT and concise onboarding links

Example use cases

  • Scaffold CONTRIBUTING.md and PR/issue templates for a new open-source library
  • Add CI job to validate that PRs include required checklist items and tests
  • Create contribution guidance for a plugin marketplace with reviewer criteria
  • Standardize contribution rules across multiple repositories in a monorepo
  • Draft a contributor onboarding flow with local dev setup and verification steps

FAQ

How do I trigger this skill?

Mention phrases like 'contributing guide creator', 'contributing creator', or 'contributing' in your request and the skill will auto-activate.

What prerequisites are required?

A configured development environment, repository access, and basic knowledge of documentation and CI. Optional: existing repo context to produce tailored guidance.