docs-generate-contributing

Generate a standardized CONTRIBUTING.md from package.json and config files.

Updated Mar 24, 2026
One-click install
npx skills add https://github.com/spencerbeggs/design-docs-plugin --skill docs-generate-contributing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-generate-contributing
Source: https://github.com/spencerbeggs/design-docs-plugin/tree/main/plugin/skills/docs-generate-contributing
Command: npx skills add https://github.com/spencerbeggs/design-docs-plugin --skill docs-generate-contributing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill solves the challenge of maintaining accurate, up-to-date onboarding documentation by automatically extracting environment requirements and development workflows directly from project configuration files.

Core Features & Use Cases

  • Automated Extraction: Parses package.json, lock files, and config files to identify Node versions, package managers, and build scripts.
  • Standardized Onboarding: Generates a comprehensive CONTRIBUTING.md that includes setup instructions, code quality standards, and DCO requirements.
  • Use Case: When onboarding a new developer to a complex repository, use this skill to instantly generate a guide that reflects the exact current state of the project's build and test commands.

Quick Start

Use the docs-generate-contributing skill to generate a new contribution guide for the current module.

Frequently Asked Questions about docs-generate-contributing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a CONTRIBUTING.md file from existing project configuration?

To generate a CONTRIBUTING.md file, this Skill parses package.json, lock files, and config files to automatically extract environment requirements, package managers, and build scripts into a standardized onboarding guide.

What is the best way to automate developer onboarding documentation for a repository?

Automating developer onboarding documentation is achieved by extracting development workflows and environment versioning directly from project configuration metadata, ensuring the generated guide reflects the exact current state of build and test commands.

How does automated contribution guide generation handle environment versioning and build scripts?

Automated contribution guide generation handles environment versioning by parsing project configuration files to identify Node versions and package managers, then documenting the extracted build scripts and code quality standards in the output file.

Can I use this to generate contribution guides for complex repositories with specific DCO requirements?

Yes, you can generate contribution guides for complex repositories. The standardized output includes setup instructions, code quality standards, and DCO requirements tailored to the project's specific configuration and development workflows.

Does the generated contribution guide stay synchronized with package metadata updates?

Generated contribution guides stay synchronized with package metadata updates by relying on automated extraction from configuration files. Running the Skill regenerates the documentation to reflect the latest package managers, lock files, and build commands.

What are the limitations of generating onboarding documentation through config file parsing?

A limitation of generating onboarding documentation through config file parsing is that it relies strictly on the accuracy of package.json and lock files, meaning undocumented manual setup steps or non-standard workflows will not be captured in the output.