Skip to content
TrustedSkillsbeta
Back to all skills

Velt Comments Best Practices

Checked
velt-js·vlatest·other

Provides clear, actionable feedback on code comments, ensuring clarity, conciseness, and adherence to best practices.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add velt-js/agent-skills --skill velt-comments-best-practices -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

velt-js

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned velt-js/agent-skills at dcc5e5d192.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
dcc5e5d192
Manifest
skills/velt-comments-best-practices/SKILL.md
Scanned
60 files, 6,650 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill provides guidance and best practices for writing effective comments in Velt.js code, ensuring clarity, maintainability, and collaboration within development teams. It helps users understand the importance of well-documented code and offers practical advice on how to achieve it. The skill aims to improve code quality by promoting consistent commenting standards.

When to use it

  • You're new to Velt.js and want to learn how to properly comment your code.
  • Your team is struggling with inconsistent commenting styles, leading to confusion.
  • You need help understanding why certain comments are more effective than others.
  • You’re refactoring existing Velt.js code and want to improve its documentation.

Key capabilities

  • Provides guidelines for writing clear and concise comments.
  • Offers advice on when to comment, and what information to include.
  • Promotes consistent commenting standards within a development team.
  • Helps ensure maintainability of Velt.js codebases.

Example prompts

  • "What are the best practices for commenting a Velt component?"
  • "How should I document a complex function in Velt.js?"
  • “Explain how to write effective JSDoc comments for my Velt hooks.”

Tips & gotchas

This skill assumes some basic familiarity with Velt.js syntax and concepts. While it provides guidance, understanding the underlying code is still crucial for writing meaningful and relevant comments.