Clean Code Naming Rules Enforcement

Sub-skill of clean-code: Naming Rules (Enforcement).

vamseeachanta 9710d85 881 B Updated

File contents

Naming Rules (Enforcement)

Naming Rules (Enforcement)

Item Rule Wrong Correct
Python files snake_case.py PipeCapacity.py pipe_capacity.py
Python dirs snake_case/ orcaflex-dashboard/ orcaflex_dashboard/
Classes PascalCase pipe_capacity PipeCapacity
Functions snake_case calcWallThick calc_wall_thickness
Constants SCREAMING_SNAKE safetyFactor SAFETY_FACTOR
Private helpers _snake_case __helper _helper
Test files test_<module>.py PipeCapacityTest.py test_pipe_capacity.py

Quick check for PascalCase file names (violation):

find src/ -name "*.py" | grep -E '/[A-Z][a-zA-Z]+\.py$'

vamseeachanta/workspace-hub/tree/main/.agents/skills/_archive/workspace-hub/clean-code/naming-rules-enforcement commit 9710d85b95

Frequently asked questions

npx skillmds@latest add vamseeachanta/clean-code-naming-rules-enforcement