generate-conventions

Community

Automate convention documentation for projects, streamline onboarding.

Authorrogsme
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the generation of a CONVENTIONS.md file, documenting coding standards and conventions for a project, significantly reducing the time required for onboarding new contributors.

Core Features & Use Cases

  • Automated Analysis: Analyze a project's codebase to determine existing conventions and patterns.
  • Customizable Output: Generate or update a CONVENTIONS.md file with detailed documentation.
  • Integration with Project Tools: Uses project configuration files to identify language, frameworks, and tools used.
  • Use Case: Integrate this Skill into your project's development workflow to maintain an up-to-date coding standards document automatically.

Quick Start

Run the skill with the project codebase as input to generate the conventions documentation.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: generate-conventions
Download link: https://github.com/rogsme/dotfiles/archive/main.zip#generate-conventions

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.