write-coding-standards-from-file
๐ฏSkillfrom github/awesome-copilot
Generates coding standards documents by analyzing coding styles and patterns from existing source files.
Overview
This skill generates coding standards documents by analyzing existing source files to extract coding styles, patterns, and conventions. It examines one or more files (or entire folders), identifies the established coding style, and produces a comprehensive standards document that codifies the project's existing practices into a formal reference.
Key Features
- Style Extraction from Code - Analyzes provided source files to identify naming conventions, formatting patterns, comment styles, error handling approaches, and architectural patterns already in use
- Multiple Output Formats - Supports verbose, minimal, best-fit, and custom template styles for the generated standards document, adapting to different documentation needs
- Inconsistency Detection - Optionally finds and fixes coding style inconsistencies within the analyzed files, improving code consistency alongside documentation
- Flexible File Output - Automatically names the output file from a priority list (CONTRIBUTING.md, STYLE.md, CODING_STANDARDS.md, etc.), using the first non-existing filename to avoid conflicts
- Multi-File Analysis - When given multiple files or a folder, aggregates coding patterns across all files into a single unified standards document
Who is this for?
Tech leads and development teams who want to formalize their existing coding conventions into a written standards document. Ideal for projects that have an established codebase but lack formal coding guidelines, or teams onboarding new developers who need a clear reference for the project's coding style.
Same repository
github/awesome-copilot(224 items)
Installation
npx vibeindex add github/awesome-copilot --skill write-coding-standards-from-filenpx skills add github/awesome-copilot --skill write-coding-standards-from-file~/.claude/skills/write-coding-standards-from-file/SKILL.mdSKILL.md
More from this repository10
A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.
A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.
Generates comprehensive Product Requirements Documents (PRDs) by systematically analyzing requirements and crafting detailed technical specifications
A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.
Generates Excalidraw diagrams from natural language descriptions, creating visual representations of processes, systems, relationships, and ideas.
Expert technical writer guided by the Diataxis framework, creating tutorials, how-to guides, reference docs, and explanation pages for software documentation.
Automates browser interactions, debugging, and performance analysis using Chrome DevTools for comprehensive web page inspection and control.
Provides Spring Boot best practices covering project setup, dependency injection, REST API design, data access with JPA, security configuration, and testing strategies.
A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.
Manages GitHub Issues through the GitHub API, enabling creation, searching, labeling, and triaging of issues directly from the coding environment.