Agent skill

applying-clean-code

General syntax and naming rules to keep the codebase maintainable. Use for all code generation.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/applying-clean-code

SKILL.md

Clean Code Principles

When to use this skill

  • Naming variables, functions, and files.
  • Deciding on function size and complexity.

Principles

  • Self-Documenting Names: isBookingPending > status === 1.
  • DRY (Don't Repeat Yourself): If logic is duplicated, move it to a utility or hook.
  • KISS (Keep It Simple, Stupid): Avoid over-engineering complex solutions for simple tasks.
  • Constants: Use const over let. Use uppercase constants for magic numbers/IDs: const MAX_GUESTS = 20;.

Naming Conventions

  • Components: PascalCase (TourCard.tsx).
  • Functions/Variables: camelCase (handleSubmit).
  • Interfaces: PascalCase (TourInfo).
  • Files: kebab-case or PascalCase (stay consistent with project structure).

Instructions

  • Avoid Comments: Write code so clear that comments are mostly unnecessary. Only comment the "why," not the "what."

Didn't find tool you were looking for?

Be as detailed as possible for better results