# Trellis:guidelines

> Creates or updates .specs/guidelines.md with project-wide stack, conventions, and principles. Use when starting a project or when a fundamental technology decision has changed.

- Skill: `robmclarty/trellis-guidelines` (Agent Skill, multi-file: 7 files)
- Install (CLI): `npx skillmds@latest add robmclarty/trellis-guidelines`
- Raw SKILL.md: https://api.skillmd.com/api/skills/robmclarty/trellis-guidelines/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: robmclarty (https://skillmd.com/u/robmclarty)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/robmclarty/trellis-guidelines

---


# Guidelines

## When to use

- "set up guidelines", "update guidelines"
- "change our stack", "add a convention"
- Any request to establish or modify project-wide principles

Create or update the project guidelines document at `.specs/guidelines.md`.

**Recommended effort: medium.** Interview-driven with structured generation into a fixed section template.

## Pre-flight

Run `python3 ${CLAUDE_PLUGIN_ROOT}/scripts/validate-prereqs.py guidelines` and use the `specsDir` value from the JSON output. Abort if the output reports missing prerequisites.

## Modes

This skill operates in two modes depending on whether `.specs/guidelines.md` already exists.

### Create mode (no existing guidelines)

If `.specs/guidelines.md` does not exist, this is a fresh project. Ask the user:

1. What is the tech stack? (language, runtime, framework, core libraries)
2. What architectural style do they prefer? (functional, OOP, procedural, hybrid)
3. Any hard conventions? (naming, file layout, error handling patterns)
4. What's the testing philosophy? (when to test, what to skip, coverage attitude, framework, file location pattern, naming convention)
5. Deployment and infrastructure constraints?
6. What is the check command? This is the full CLI command chain that must pass for code to be considered correct — it runs after every implementation task. (e.g., `npm run lint && npm run typecheck && npm run build && npm run test`, or `ruff check . && mypy . && pytest`)

If the user provides a description or the project already has code, infer what you can and confirm with them.

### Update mode (existing guidelines)

If `.specs/guidelines.md` already exists, read it first. Then ask the user:

1. What changed? (new library, dropped dependency, revised convention, infrastructure shift)
2. Why? (one sentence is fine; this helps evaluate downstream impact)

## Generation

After gathering all user input via the interview, spawn the `guideliner` agent. Pass it: the specs directory path and all interview responses. The agent will generate the guidelines document.

## Quality gate

- [ ] Could a new developer read this and write code that matches the project's style?
- [ ] Are there concrete examples (not just rules) for every convention?
- [ ] Is every stack decision specific (named packages, not categories)?
- [ ] Does it avoid feature-specific content? (That belongs in specs, not guidelines.)

