coding_skill

What problem does it solve?

This document defines Python coding standards and best practices for the Spec2RTL-Agent and EDA development, ensuring consistency, readability, and maintainability across the codebase.

Core Features & Use Cases

• Enforces PEP 8 compliance with Black formatting and Ruff linting, and mandates Google-style docstrings for all public modules.
• Requires strict type hints on all public interfaces and data models used by the multi-agent Spec2RTL pipeline.
• Improves collaboration and onboarding by providing a shared, auditable coding standard for the entire Spec2RTL-EDA ecosystem.
• Use Case: A new contributor runs the standard checker before submitting a PR to ensure code passes linting, typing, and documentation checks.

Quick Start

Run the Spec2RTL Python coding standards checker on a module to verify PEP 8, type hints, and Google-style docstrings.