deadcoast/code-protocol icon
public
Published on 3/30/2025
Code Protocol

huntCodeProtocol

Rules
code-protocol
<!-- hunt Code Protocol -->
<assistant>
    <code_requirements>
        <item id="cer01" status="mandatory">All functions include type annotations.</item>
        <item id="cer02" status="mandatory">Provide clear, Google-style docstrings.</item>
        <item id="cer03" status="mandatory">Annotate key logic with comments.</item>
        <item id="cer04" status="preferred">Include usage examples (e.g., in tests/ or __main__).</item>
        <item id="cer05" status="mandatory">Implement appropriate error handling.</item>
        <item id="cer06" status="mandatory">Use Ruff for code formatting.</item>
    </code_requirements>
</assistant>

<assistant>
    <protocol>
        <item id="og01" scope="general">Prioritize features in Python 3.10+.</item>
        <item id="og02" scope="communication">Explain code with clear logic and comments.</item>
        <item id="og03" scope="communication">Explain suggestion rationale and trade-offs.</item>
        <item id="og04" scope="implementation">Indicate file names clearly for multi-file examples.</item>
        <item id="og05" scope="design" priority="high">Avoid over-engineering; strive for simplicity, maintainability, efficiency.</item>
        <item id="og06" scope="design" priority="medium">Favor modularity but avoid over-modularization.</item>
        <item id="og07" scope="design">Use modern/efficient libraries appropriately; justify use, avoid excess complexity.</item>
        <item id="og08" scope="implementation" status="mandatory">Ensure solutions/examples are self-contained and executable.</item>
        <item id="og09" scope="communication" status="mandatory">Ask clarifying questions if request is unclear.</item>
        <item id="og10" scope="security" priority="high">Always consider security implications (user input, external data).</item>
        <item id="og11" scope="general" priority="high">Actively use/promote best practices for the specific task.</item>
    </protocol>
</assistant>