skills.rest
cameronraysmith
cameronraysmithCOMMUNITY
Explore all skills by this author →
Website𝕏@cameronraysmithGitHub

preferences-style-and-conventions

Enforce consistent style and formatting conventions across code and documentation.

14|Updated May 28, 2024
Search Tags:#code review#file organization#developer workflow#coding conventions#style guide#documentation standards
One-click install
npx skills add https://github.com/cameronraysmith/vanixiets --skill preferences-style-and-conventions
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: preferences-style-and-conventions
Source: https://github.com/cameronraysmith/vanixiets/tree/main/modules/home/ai/skills/src/core/preferences-style-and-conventions
Command: npx skills add https://github.com/cameronraysmith/vanixiets --skill preferences-style-and-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses inconsistencies in code, documentation, naming, and file organization, ensuring a unified and professional standard across projects.

Core Features & Use Cases

  • Style Enforcement: Defines clear guidelines for Markdown, naming, and factual commentary.
  • File Organization: Provides a strategy for structuring files and managing their length.
  • Workflow Optimization: Outlines pre-implementation checkpoints and CI log verification best practices.
  • Use Case: When starting a new project or reviewing a colleague's code, use this Skill to ensure all contributions adhere to established style guides, improving readability and maintainability.

Quick Start

Review the style and formatting conventions for code and documentation.

Frequently Asked Questions about preferences-style-and-conventions

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

FAQPage Schema
How do I enforce consistent coding conventions and documentation style across a project?▼

You can enforce coding conventions by applying standardized rules for markdown formatting, naming, factual commentary, and file modularization. This ensures a unified professional standard across all project artifacts and code reviews.

What's the best way to standardize file organization and manage file length for a new project?▼

Standardizing file organization requires a strategy that defines file structures and manages their length. Establishing these conventions early ensures maintainability and readability as the project grows.

How do I set up developer workflow checkpoints for code review and CI log verification?▼

Setting up developer workflow checkpoints involves outlining pre-implementation review steps and CI log verification best practices. This enforces adherence to established style guides before merging contributions.

Does this style guide apply to commit messages and code comments, or just source code?▼

This style guide applies to all project artifacts, including source code, markdown files, code comments, and commit messages. It requires adherence to specific rules for prose, capitalization, and factual commentary.

When do I need coding conventions for documentation standards?▼

You need coding conventions for documentation standards when starting a new project or reviewing a colleague's code. Applying these guidelines ensures all contributions adhere to established style rules, improving overall readability.

Related Skills

Explore More Software Engineering Skills→
danghungtb26danghungtb26
3

project-conventions

Enforce naming and folder structure conventions for React TypeScript admin templates.

Community
Basic
t-stringst-strings

Global Coding Style

Enforce global coding style across codebases with linters and formatters.

Official
Basic
arcasilesgrouparcasilesgroup
54

commit

Stage, lint, detect secrets, commit, and push code with governance checks.

Official
Advanced
deandumdeandum
3

style

Enforce language-agnostic coding style and conventions across a codebase.

Community
Intermediate