Skip to content

docs: add agent-generic SKILLS.md#565

Merged
charphi merged 4 commits into
nbbrd:developfrom
koppor:docs/add-skills-md
Jun 23, 2026
Merged

docs: add agent-generic SKILLS.md#565
charphi merged 4 commits into
nbbrd:developfrom
koppor:docs/add-skills-md

Conversation

@koppor

@koppor koppor commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

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 check and rules as the primary task:

  • check — invocation, output formats, options.
  • Rule configuration--rule <id>:<severity> (incl. OFF) and the persistent heylogs.properties equivalent, with hierarchical auto-discovery, override/stopBubbling/--no-config semantics.
  • Config-only pattern — getting one or more repos to "0 problems" purely via heylogs.properties, without editing changelog content.
  • All built-in rules — table of every rule with its default severity and a one-line description.
  • Other commandsinit, push, fetch, note, format, release, yank, scan, extract, export, import, list.
  • Running the CLIgg.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.md from AGENTS.md and README.md so agents and users can discover it (SKILLS.md is 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 the heylogs.properties template.

🤖 Generated with Claude Code

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>
@charphi

charphi commented Jun 16, 2026

Copy link
Copy Markdown
Member

@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.
It seems to me that it should follow the skills.sh convention to use specific folders and structure (i.e. skills/my-skill-command) ?
Here is an example of it: https://github.com/ondata/opensdmx/blob/main/docs/skill/README.md

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>
@koppor

koppor commented Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

I have very little experience, but npx skills seems to be nice - and one is then listed in the skills.sh page - currently many tools for changelog: https://www.skills.sh/?q=changelog

npx skills add nbbrd/heylogs --skill heylogs

Seems OK - maybe the --skill heylogs can be ommited?

koppor and others added 2 commits June 23, 2026 02:29
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>
@charphi

charphi commented Jun 23, 2026

Copy link
Copy Markdown
Member

Thanks for the contribution!

Seems OK - maybe the --skill heylogs can be ommited?

I don't know; I don't have any experience with npx.

@charphi charphi merged commit 2db9c8f into nbbrd:develop Jun 23, 2026
11 checks passed
@koppor koppor deleted the docs/add-skills-md branch June 23, 2026 10:41
@koppor

koppor commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

Current state:

grafik

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants