docs: add agent-generic SKILLS.md#565
Conversation
Add a SKILLS.md guide for using the heylogs CLI (check, rule tuning via --rule and heylogs.properties, all built-in rules, other commands) plus how to run it via gg.cmd/JBang. Link to it from AGENTS.md and README.md so agents and users can discover it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
@koppor thanks for the suggestion; this is a great idea. But before merging, I'm wandering if the file SKILLS.md at the root of the project is the right place to put it. |
Move the root SKILLS.md into skills/heylogs/ following the Agent Skills convention (the layout distributed by skills.sh / `npx skills`): - skills/heylogs/SKILL.md: YAML frontmatter (name + trigger-phrase description) plus a concise guide. Body stays agent-generic; only the frontmatter is spec-shaped. - skills/heylogs/references/: rule table, heylogs.properties semantics, CLI runners, and per-command tables split out for progressive loading. - skills/heylogs/README.md: install guide (`npx skills add nbbrd/heylogs --skill heylogs`). Single cohesive `heylogs` skill (not per-command). No skills-lock.json (that is a consumer lockfile, not needed to publish a skill). Repoint the AGENTS.md and README.md links to the skill. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
I have very little experience, but Seems OK - maybe the |
Replace gg.cmd bootstrapping with JBang's install-script pipe (curl -Ls https://sh.jbang.dev | bash -s - ...) and document JBANG_USE_NATIVE=true for near-instant startup via JBang's native binary. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Thanks for the contribution!
I don't know; I don't have any experience with npx. |

Thought, It would be nice to teach Claude (and/or other AI agents) how to check (and fix) CHANGELOG.md files. Here a (Claude-generated) proposal for SKILL.md
What
Adds
SKILLS.md, an agent-generic guide (works with any AI coding assistant) for using the Heylogs CLI on a changelog.Coverage, weighted toward
checkand rules as the primary task:check— invocation, output formats, options.--rule <id>:<severity>(incl.OFF) and the persistentheylogs.propertiesequivalent, with hierarchical auto-discovery, override/stopBubbling/--no-configsemantics.heylogs.properties, without editing changelog content.init,push,fetch,note,format,release,yank,scan,extract,export,import,list.gg.cmd(no prerequisites) and JBang, e.g.jbang com.github.nbbrd.heylogs:heylogs-cli:0.18.1:bin check CHANGELOG.md.Also links to
SKILLS.mdfromAGENTS.mdandREADME.mdso agents and users can discover it (SKILLS.mdis not an auto-discovered filename on its own).The content is derived from the existing
docs/(feature-rules, feature-check, feature-config-file, usage-cli, per-command docs) and theheylogs.propertiestemplate.🤖 Generated with Claude Code