Verified:GitHub

example-skill

Name: example-skill
Availability: InStock
Author: okgoogle13

Checks and formats YardDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDogDog for YAML style compliance.

1|Updated Aug 12, 2025

Search Tags:#best practices #documentation #style guide #configuration #reference #yaml #example

Ready to run

npx skills add https://github.com/okgoogle13/careercopilot --skill example-skill-okgoogle13

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: example-skill
Source: https://github.com/okgoogle13/careercopilot/tree/main/.claude/skills/example-skill
Command: npx skills add https://github.com/okgoogle13/careercopilot --skill example-skill-okgoogle13

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Understanding and implementing best practices for YAML configuration can be challenging, leading to inconsistent or error-prone files. This skill provides a clear, self-contained example to guide users in writing clean, maintainable YAML.

Core Features & Use Cases

YAML Best Practices: Demonstrates proper indentation (2 spaces), key-value formatting, string quoting, and list item usage for clean, readable YAML.
Naming Conventions: Illustrates recommended naming for file names (lowercase-hyphens), keys (camelCase), and environment variables (UPPER_SNAKE_CASE).
Reference Guides: Links to internal documentation for a comprehensive YAML style guide and example configuration, ensuring thorough learning.
Use Case: Ideal for new developers or teams looking to standardize their YAML configurations, ensuring readability, maintainability, and consistency across projects.

Quick Start

Show me the example skill's YAML configuration and style guide.

Frequently Asked Questions about example-skill

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

FAQPage Schema

How do I format YAML files correctly for configuration and documentation?▼

YAML formatting requires 2-space indentation, key: value pairs with a space after the colon, quotes for special characters, and dash-prefixed lists. This skill demonstrates these best practices with a clear example to ensure consistent, readable YAML across projects.

What are the naming conventions for YAML keys, files, and environment variables?▼

YAML best practices use lowercase-hyphenated file names, camelCase for keys, and UPPER_SNAKE_CASE for environment variables. This skill illustrates proper naming conventions to maintain consistency and readability in your configuration files.

How do I validate YAML structure and indentation in skill definitions?▼

YAML validation checks indentation consistency, key: value spacing, quote usage, and list formatting against style-guide rules. This skill enforces standard YAML constraints and outputs validated, reference-aligned metadata for skill repositories.

What's the best way to standardize YAML configurations across a team or project?▼

Standardizing YAML requires documented style guides, consistent indentation and formatting rules, and clear naming conventions. This skill provides a self-contained example and reference documentation to align your team on YAML best practices.

Can I use this skill to enforce YAML style guides in my documentation and configuration files?▼

Yes, this skill applies YAML style constraints to documentation, reference files, and skill definitions, enforcing indentation, spacing, and naming standards. It outputs consistent metadata that adheres to your style-guide requirements.