coding_guidelines

Enforce coding standards for Lua, Zsh, configuration files, and Markdown.

5|Updated Jan 21, 2011
One-click install
npx skills add https://github.com/minusfive/dot --skill coding-guidelines-minusfive
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coding_guidelines
Source: https://github.com/minusfive/dot/tree/main/.claude/skills/coding-guidelines
Command: npx skills add https://github.com/minusfive/dot --skill coding-guidelines-minusfive

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive set of coding standards and guidelines to maintain high code quality, consistency, and best practices across the macOS dotfiles project.

Core Features & Use Cases

  • Standardized Coding Practices: Enforces consistent approaches for Lua, Zsh, configuration files, and Markdown.
  • Test-Driven Development (TDD): Promotes a strict TDD workflow for reliable and maintainable code.
  • Use Case: When writing a new Zsh script, consult these guidelines to ensure it adheres to error-handling standards and logging conventions, making it robust and easy to integrate.

Quick Start

Review the coding guidelines before writing new Zsh scripts.

Frequently Asked Questions about coding_guidelines

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

FAQPage Schema
How do I enforce coding standards and best practices for a macOS dotfiles project?

You can enforce coding standards by applying consistent guidelines for Lua, Zsh, configuration files, and Markdown, ensuring high code quality and consistency across your macOS dotfiles project during development, review, and refactoring.

What are the best practices for writing Zsh scripts with consistent error handling?

Best practices for Zsh scripts include adhering to established error-handling standards and logging conventions. Consulting coding guidelines before writing scripts ensures they are robust, reliable, and easy to integrate into the dotfiles repository.

Does this coding guidelines Skill support a test-driven development workflow?

Yes, the coding guidelines Skill supports a test-driven development (TDD) workflow. It promotes strict TDD principles to ensure your Lua and Zsh code remains reliable and maintainable throughout the development lifecycle.

Can I use these coding standards for both Lua scripts and Markdown documentation?

Yes, you can use these coding standards for both Lua and Markdown. The guidelines enforce standardized coding practices and consistent approaches specifically tailored for Lua scripts, configuration files, and Markdown documentation.

When do I need to consult coding guidelines before refactoring dotfiles?

You need to consult coding guidelines before refactoring dotfiles whenever you modify Lua or Zsh code. Applying these standards during code review and refactoring ensures adherence to functional patterns and consistent naming conventions.