policy-general-coding

Enforce consistent coding standards across languages and teams.

1|Updated Oct 5, 2025
One-click install
npx skills add https://github.com/simon-downes/agent-workspace --skill policy-general-coding
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: policy-general-coding
Source: https://github.com/simon-downes/agent-workspace/tree/main/skills/policy-general-coding
Command: npx skills add https://github.com/simon-downes/agent-workspace --skill policy-general-coding

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This policy provides core principles and practices for writing maintainable, high-quality code across languages, helping teams avoid defects and inconsistencies.

Core Features & Use Cases

  • SOLID: Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, Dependency Inversion.
  • DRY and YAGNI: avoid duplication where it harms clarity, resist over-generalization.
  • KISS and simplicity: favor simple, clear designs that match problem complexity.
  • Documentation and Type Safety: require docstrings, type hints, and clear APIs.
  • Error Handling and Logging: robust, predictable error handling, structured logging.
  • Security and Best Practices: validate inputs, avoid secrets in code, secure defaults.
  • Code Organization: descriptive naming, modular structure, and consistent formatting.

Quick Start

Apply these standards to your codebase to improve readability, maintainability, and consistency.

Frequently Asked Questions about policy-general-coding

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

FAQPage Schema
How do I enforce consistent coding standards across multiple programming languages?

To enforce consistent coding standards across multiple languages, apply core software engineering principles like SOLID, DRY, and KISS alongside requirements for descriptive naming, type hints, and modular design. This ensures high-quality, maintainable code across your entire team.

What is the best way to handle error handling and logging in software engineering?

The best way to handle error handling and logging is to implement robust, predictable error management combined with structured logging. Validate inputs and use secure defaults to ensure your application fails safely and provides traceable diagnostic information.

How do SOLID, DRY, and KISS principles improve code maintainability?

SOLID, DRY, and KISS principles improve code maintainability by enforcing single responsibility, avoiding duplication, and favoring simple designs that match problem complexity. This approach resists over-generalization and creates clear, predictable APIs.

Does this coding policy require specific type hints and documentation for all APIs?

Yes, this coding policy requires type hints, docstrings, and clear API documentation. These documentation and type safety guidelines are enforced to improve readability, maintainability, and consistency across the codebase.

Can I use these coding standards for architectural decisions and code reviews?

Yes, you can use these coding standards for architectural decisions and code reviews. The guidelines cover modular structure, security, and consistent formatting, helping teams guide development workflows and improve overall software maintainability.

Why should I avoid hardcoding secrets and how does this policy address security?

You should avoid hardcoding secrets to prevent vulnerabilities, and this policy addresses security by requiring input validation, secure defaults, and keeping secrets out of code. These practices enforce robust, high-quality software engineering standards.