diff --git a/CLAUDE.md b/CLAUDE.md index 523806cff..bb3fbbf85 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -22,6 +22,8 @@ npm run validate-redirects # Validate .gitbook.yaml redirects **Always run `npm run format` before committing.** CI auto-commits formatting fixes on non-main branches, but formatting locally avoids noise. +**Use semantic naming for commits, branches, and PRs.** Prefix commit messages with a type (`feat:`, `fix:`, `docs:`, `chore:`, `ci:`, `refactor:`, `test:`). Use the same style for branch names (e.g., `docs/update-sandbox-credentials`) and PR titles. + Optional external tools used during `npm run generate` for code sample formatting: `ruff` (Python), `shfmt` (shell), `gofmt` (Go), `stree` from `syntax_tree` gem (Ruby). ## Architecture diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md index 60e9ef49e..5b35c409e 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/ecobee-sample-data.md @@ -2,6 +2,6 @@ Use the following set of credentials to add virtual [ecobee thermostats](https://docs.seam.co/latest/device-and-system-integration-guides/ecobee-thermostats) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): -| Email Address | Password | -| --------------------------------------------------------------- | -------- | -| jane@example.com or any email address in the example.com domain | 1234 | +| Email Address | Password | +| ---------------- | -------- | +| jane@example.com | 1234 | diff --git a/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md b/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md index 3dbd638d8..ac18ecc18 100644 --- a/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md +++ b/docs/guides/developer-tools/sandbox-and-sample-data/ttlock-sample-data.md @@ -2,6 +2,6 @@ Use the following set of credentials to add virtual [TTLock locks](https://docs.seam.co/latest/device-and-system-integration-guides/ttlock-locks) to your Seam [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces): -| Email Address | Password | -| --------------------------------------------------------------- | -------- | -| jane@example.com or any email address in the example.com domain | 1234 | +| Email Address | Password | +| ---------------- | -------- | +| jane@example.com | 1234 |