Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .agents/skills/trellis-onboarding/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
name: trellis-onboarding
description: >
Use when the user asks to onboard to Trellis, set up Trellis, or otherwise mentions onboarding to Trellis.
Use when the user asks to onboard to trellis, set up trellis, or otherwise mentions onboarding to trellis.
---

Onboard the repo to use Trellis. This includes adding the Trellis config file, converting any existing changelog and
Onboard the repo to use trellis. This includes adding the trellis config file, converting any existing changelog and

## Initial Setup

First confirm that the project is a Gleam project. If not, explain to the user that Trellis is designed for Gleam projects.
First confirm that the project is a Gleam project. If not, explain to the user that trellis is designed for Gleam projects.

Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to Trellis. If they want to switch, clarify that Trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to Trellis.
Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to trellis. If they want to switch, clarify that trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to trellis.

## Migration

Refer to the documentation for Trellis for instructions on how to migrate existing repos to Trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to Trellis.
Refer to the documentation for trellis for instructions on how to migrate existing repos to trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to trellis.

## Reference

- Documentation for Trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com.
- Documentation for trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com.
12 changes: 6 additions & 6 deletions .apm/skills/trellis-onboarding/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
name: trellis-onboarding
description: >
Use when the user asks to onboard to Trellis, set up Trellis, or otherwise mentions onboarding to Trellis.
Use when the user asks to onboard to trellis, set up trellis, or otherwise mentions onboarding to trellis.
---

Onboard the repo to use Trellis. This includes adding the Trellis config file, converting any existing changelog and
Onboard the repo to use trellis. This includes adding the trellis config file, converting any existing changelog and

## Initial Setup

First confirm that the project is a Gleam project. If not, explain to the user that Trellis is designed for Gleam projects.
First confirm that the project is a Gleam project. If not, explain to the user that trellis is designed for Gleam projects.

Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to Trellis. If they want to switch, clarify that Trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to Trellis.
Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to trellis. If they want to switch, clarify that trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to trellis.

## Migration

Refer to the documentation for Trellis for instructions on how to migrate existing repos to Trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to Trellis.
Refer to the documentation for trellis for instructions on how to migrate existing repos to trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to trellis.

## Reference

- Documentation for Trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com.
- Documentation for trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com.
12 changes: 6 additions & 6 deletions .claude/skills/trellis-onboarding/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
name: trellis-onboarding
description: >
Use when the user asks to onboard to Trellis, set up Trellis, or otherwise mentions onboarding to Trellis.
Use when the user asks to onboard to trellis, set up trellis, or otherwise mentions onboarding to trellis.
---

Onboard the repo to use Trellis. This includes adding the Trellis config file, converting any existing changelog and
Onboard the repo to use trellis. This includes adding the trellis config file, converting any existing changelog and

## Initial Setup

First confirm that the project is a Gleam project. If not, explain to the user that Trellis is designed for Gleam projects.
First confirm that the project is a Gleam project. If not, explain to the user that trellis is designed for Gleam projects.

Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to Trellis. If they want to switch, clarify that Trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to Trellis.
Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to trellis. If they want to switch, clarify that trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to trellis.

## Migration

Refer to the documentation for Trellis for instructions on how to migrate existing repos to Trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to Trellis.
Refer to the documentation for trellis for instructions on how to migrate existing repos to trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to trellis.

## Reference

- Documentation for Trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com.
- Documentation for trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com.
29 changes: 24 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@
Guidance for agents working in this repository. See [docs/DESIGN.md](docs/DESIGN.md)
for what trellis is and why.

## Product-name capitalization

Use **trellis** in running text and **Trellis** at the start of a sentence and
in document titles. Use sentence case for headings: "Installing trellis", not
"Installing Trellis". This keeps the existing convention without rewriting
CLI output or generated documentation.

- Keep the visual wordmark lowercase: **trellis**.
- Preserve literal spelling in commands (`trellis doctor`), binary and crate
names, paths, URLs, config keys (`[tools.trellis]`), schema names
(`trellis.doctor/1`), and environment variables (`TRELLIS_NO_UPDATE_CHECK`).
Do not capitalize a command just because it starts a sentence or heading.
- Leave published release notes and quoted historical output unchanged.

## Naming: snake_case for everything we control

**Every identifier trellis defines is snake_case.** That covers:
Expand Down Expand Up @@ -34,9 +48,13 @@ new keys never get one.

## Changelog fragments

Every user-visible change needs one: a YAML file in `.changes/unreleased/` named
`<Kind>-<YYYYMMDD>-<slug>.yaml`, with `component`, `kind`, `body`, and `time`. The
audience is a stranger reading the release notes, not the reviewer of your PR.
**Only user-facing product changes need a changelog fragment.** Documentation,
tests, CI, infrastructure, and internal maintenance do not need one unless they
also change user-facing product behavior.

For a product change, add a YAML file in `.changes/unreleased/` named
`<Kind>-<YYYYMMDD>-<slug>.yaml`, with `component`, `kind`, `body`, and `time`.
The audience is a stranger reading the release notes, not the reviewer of your PR.

**This section is about trellis's own changelog, which changie manages — not
about the fragments trellis writes.** The two formats are different and easy to
Expand Down Expand Up @@ -138,8 +156,9 @@ Edit the clap definitions, then run `just docs`.
Releases are fully automated, fragment-driven, and hands-off after merge —
the same pipeline as [repoverlay](https://github.com/tylerbutler/repoverlay):

1. Every user-facing change lands with a changie fragment (`changie new`);
fragments accumulate in `.changes/unreleased/`.
1. Every user-facing product change lands with a changie fragment (`changie new`);
documentation, tests, and infrastructure alone do not need one. Fragments
accumulate in `.changes/unreleased/`.
2. On each push to `main`, `changie-release.yml` batches the fragments into a
release PR that bumps `Cargo.toml`, regenerates `Cargo.lock`, and updates
`CHANGELOG.md`.
Expand Down
Loading