light-comments

Name: light-comments
Author: lxsmnsyc

Keep comments light: short enough to read at a glance, and about the why rather than the what.

by lxsmnsyc(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from lxsmnsyc/overwander (.github/instructions/light-comments.instructions.md). Copyright stays with the author.

Keep comments light: short enough to read at a glance, and about the why rather than the what.

Most blocks are 1-4 lines. Over ~8 needs a real reason: a formula, a protocol, a subtle invariant, a module header.
Say the non-obvious reason, the constraint, the trap. Never restate the signature or the line below.
No design history ("It used to be...", "This replaced...") - that is in git.
No build-up: one statement of the point, not a paragraph arriving at it.
Keep verbatim: lint directives, external links, formulas, and any warning that prevents a bug.
Light is not cryptic. Full sentences, no shorthand, no unresolvable references.

Full convention with examples: .agents/skills/light-comments/SKILL.md.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/lxsmnsyc-overwander-light-comments-instructions/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

lxsmnsyc-overwander-light-comments-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "lxsmnsyc-overwander-light-comments-instructions",
  "kind": "skill",
  "name": "light-comments",
  "description": "Keep comments light: short enough to read at a glance, and about the why rather than the what.",
  "publisher": "lxsmnsyc",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Keep comments light: short enough to read at a glance, and about the why rather than the what."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/lxsmnsyc/overwander",
      "path": ".github/instructions/light-comments.instructions.md",
      "ref": "46e7095c16a8e929043c047957b06b6f58af6fe1",
      "url": "https://github.com/lxsmnsyc/overwander/blob/46e7095c16a8e929043c047957b06b6f58af6fe1/.github/instructions/light-comments.instructions.md",
      "key": "lxsmnsyc/overwander/.github/instructions/light-comments.instructions.md"
    },
    "applies_to": "**"
  },
  "instructions": "Keep comments light: short enough to read at a glance, and about the why rather than the what.\n\n- Most blocks are 1-4 lines. Over ~8 needs a real reason: a formula, a protocol, a subtle invariant, a module header.\n- Say the non-obvious reason, the constraint, the trap. Never restate the signature or the line below.\n- No design history (\"It used to be...\", \"This replaced...\") - that is in git.\n- No build-up: one statement of the point, not a paragraph arriving at it.\n- Keep verbatim: lint directives, external links, formulas, and any warning that prevents a bug.\n- Light is not cryptic. Full sen",
  "cost": {
    "context_tokens": 180
  }
}

Fetch it by URL: GET /api/v1/registry/lxsmnsyc-overwander-light-comments-instructions/manifest?version=1.0.0

About

Use it

Manifest

Reviews