Skip to content

docs: add {{PLACEHOLDER}} reference table to CONTRIBUTING.md#757

Open
Gonzih wants to merge 1 commit intogarrytan:mainfrom
Gonzih:docs/placeholder-reference
Open

docs: add {{PLACEHOLDER}} reference table to CONTRIBUTING.md#757
Gonzih wants to merge 1 commit intogarrytan:mainfrom
Gonzih:docs/placeholder-reference

Conversation

@Gonzih
Copy link
Copy Markdown

@Gonzih Gonzih commented Apr 1, 2026

Summary

CONTRIBUTING.md mentions {{BASE_BRANCH_DETECT}} once but doesn't document the full set of available {{PLACEHOLDER}} tokens. Contributors writing new skills currently have to grep scripts/resolvers/index.ts and scripts/resolvers/*.ts to discover what's available.

This adds a reference table in the "Editing SKILL.md files" section covering all 20+ placeholders with:

  • What each one injects (one-line description)
  • Placement guidance (where in a skill template to put it)
  • Parameterized usage note

Why

The resolver system is one of gstack's most powerful features — it lets skills share battle-tested prose about learnings, design methodology, review workflows, and deploy detection without duplication. But it's entirely undiscoverable without reading the source. This table makes the system visible.

Practical impact: a new contributor writing their first skill will immediately know to add {{LEARNINGS_SEARCH}} + {{LEARNINGS_LOG}}, pick the right preamble-tier, and use {{BASE_BRANCH_DETECT}} instead of hardcoding main.

What's NOT in this PR

The full behavior of each resolver lives in scripts/resolvers/*.ts. This table only describes the intent and placement — not the full resolved output, which can be read from any generated SKILL.md.

🤖 Generated with Claude Code

The CONTRIBUTING.md mentions {{BASE_BRANCH_DETECT}} in passing but
doesn't document the full set of available {{PLACEHOLDER}} tokens.
Contributors writing new skills have to grep the codebase to discover
what's available.

Add a reference table covering all 20+ placeholders with descriptions,
placement guidance, and a note on parameterized usage. This lives in the
"Editing SKILL.md files" section, directly after the existing pointer
to CLAUDE.md's template authoring guide.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant