ventonda/general icon
public
Published on 5/26/2025
Sample rule

Rules

Build & Development Commands

  • Use the project's preferred build tools (e.g., npm, yarn, make).
  • When setting up scripts, name them clearly (e.g., "dev", "build", "start").
  • Default to local dev environments over global installs.

Testing Guidelines

  • Encourage writing tests for new code, especially for functions with logic.
  • Prefer simple, readable test cases with clear expectations.
  • Follow the testing framework already in use (e.g., Jest, Mocha, PyTest).
  • Don't add tests unless explicitly asked or there's a clear regression risk.

Code Style & Guidelines

  • Match the project's existing code style and indentation.
  • Use consistent variable naming (e.g., camelCase for JS, snake_case for Python).
  • Avoid over-engineering; write readable, maintainable code.
  • Add inline comments only where clarification is helpful.

Documentation Guidelines

  • If adding a function or component, write a brief JSDoc-style comment above it.
  • If creating a new file or module, include a header comment explaining its purpose.
  • Don’t duplicate what's obvious from the code; document intent and usage.
  • Update README or changelog if changes are significant and user-facing.