coding_skill

Validate Python modules for PEP 8, type hints, and Google-style docstrings.

15|3|Updated Mar 11, 2026
One-click install
npx skills add https://github.com/CirbuildProject/Cirbuild-Spec2RTL --skill coding-skill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coding_skill
Source: https://github.com/CirbuildProject/Cirbuild-Spec2RTL/tree/main
Command: npx skills add https://github.com/CirbuildProject/Cirbuild-Spec2RTL --skill coding-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about coding_skill

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

FAQPage Schema
How do I enforce PEP 8 and Google-style docstrings in a Python EDA pipeline?

To enforce PEP 8 and Google-style docstrings in a Python EDA pipeline, use a coding standards checker that validates style, strict type hints, and documentation across all modules to ensure consistency and maintainability.

What are the Python type hint requirements for multi-agent Spec2RTL workflows?

Python type hint requirements for multi-agent Spec2RTL workflows mandate explicit type hints on all public interfaces and data models. This ensures strict validation across Understanding, Coding, Reflection, and HLS modules.

Does the Spec2RTL coding standard require pathlib for file system operations?

Yes, the Spec2RTL coding standard requires pathlib usage for file system operations. This requirement applies alongside strict PEP 8 compliance and explicit type hints for all public interfaces.

Can I use Black and Ruff to lint Python code for Spec2RTL-EDA development?

Yes, you can use Black and Ruff to lint Python code for Spec2RTL-EDA development. The coding standards specifically enforce PEP 8 compliance through Black formatting and Ruff linting.

When do I need to run the Python coding standards checker in a multi-agent pipeline?

You need to run the Python coding standards checker before submitting a pull request to verify PEP 8, type hints, and Google-style docstrings. This ensures code passes linting, typing, and documentation checks for the multi-agent workflow.

Why does consistent Python coding style matter across EDA pipeline modules?

Consistent Python coding style matters across EDA pipeline modules because it improves collaboration, onboarding, and maintainability. It provides a shared, auditable standard for the entire Spec2RTL-EDA ecosystem.