You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
4.**Shortcuts**: Reusable instruction templates for common workflows (code review,
23
23
commits, PRs, cleanup, handoffs).
@@ -79,6 +79,7 @@ or want help → run `tbd shortcut welcome-user`
79
79
| “Create a PR” / “File a PR” |`tbd shortcut create-or-update-pr-simple`|
80
80
| “Merge main into my branch” |`tbd shortcut merge-upstream`|
81
81
|**Guidelines & Knowledge**||
82
+
|*(any engineering work)*| Load the **General engineering** group first (see below) |
82
83
| “Use TypeScript best practices” |`tbd guidelines typescript-rules`|
83
84
| “Use Python best practices” |`tbd guidelines python-rules`|
84
85
| “Build a TypeScript CLI” |`tbd guidelines typescript-cli-tool-rules`|
@@ -97,6 +98,12 @@ or want help → run `tbd shortcut welcome-user`
97
98
| “Check out this library’s source” |`tbd shortcut checkout-third-party-repo`|
98
99
|*(your choice whenever appropriate)*|`tbd list`, `tbd dep add`, `tbd close`, `tbd sync`, etc. |
99
100
101
+
**Loading guidelines for engineering work:** Before writing or reviewing code, load the
102
+
**General engineering** group—the `general-*` rules plus `error-handling-rules`—since
103
+
these apply to all code regardless of language.
104
+
Then load the group for the language or framework in use (TypeScript, Python, Convex,
105
+
etc.). Run `tbd guidelines --list` to see all available guidelines.
106
+
100
107
**Note:** Never gitignore `.tbd/workspaces/` — the outbox must be committed to your
101
108
working branch. See `tbd guidelines tbd-sync-troubleshooting` for details.
102
109
@@ -220,36 +227,67 @@ Run `tbd shortcut <name>` to use any of these shortcuts:
220
227
221
228
## Available Guidelines
222
229
223
-
Run `tbd guidelines <name>` to apply any of these guidelines:
230
+
Run `tbd guidelines <name>` to apply any of these guidelines.
231
+
Load the **General engineering** group first, then the language or framework group.
232
+
233
+
### General engineering
234
+
235
+
*Read all of these for any engineering work (writing or reviewing code).*
224
236
225
237
| Name | Description |
226
238
| --- | --- |
227
239
| backward-compatibility-rules | Guidelines for maintaining backward compatibility across code, APIs, file formats, and database schemas |
228
-
| bun-monorepo-patterns | Modern patterns for Bun-based TypeScript monorepo architecture |
229
-
| cli-agent-skill-patterns | How to write skills and agent-integrated CLIs that work across Claude Code, Codex, and the broader coding-agent ecosystem — a simple baseline plus references for advanced, multi-subcommand tools |
230
240
| commit-conventions | Conventional Commits format with extensions for agentic workflows |
231
-
| common-doc-guidelines | Common cross-project standards for writing and organizing docs, code comments, and text files — how to organize, structure, write, and format documents, plus the guideline footer convention. Downstream of github.com/jlevy/practical-prose. Use whenever writing or editing any documentation, README, guideline, or design doc. |
232
-
| convex-limits-best-practices | Comprehensive reference for Convex platform limits, workarounds, and performance best practices |
233
-
| convex-rules | Guidelines and best practices for building Convex projects, including database schema design, queries, mutations, and real-world examples |
234
-
| electron-app-development-patterns | Guidelines for Electron development ecosystems including npm, pnpm, and Bun, with security baselines and framework comparisons |
235
241
| error-handling-rules | Rules for handling errors, failures, and exceptional conditions |
236
242
| general-coding-rules | Rules for constants, magic numbers, and general coding practices |
| general-eng-assistant-rules|Rules for AI assistants acting as senior engineers, including objectivity and communication guidelines|
244
+
| general-eng-agent-principles|Core principles for AI agents acting as senior engineers—objectivity and communication conduct plus the engineering process (detailed understanding, verification, end-to-end ownership, scope discipline, tracking future work, and acting versus seeking clarification)|
239
245
| general-tdd-guidelines | Test-Driven Development methodology and best practices |
240
246
| general-testing-rules | Rules for writing minimal, effective tests with maximum coverage |
241
247
| golden-testing-guidelines | Guidelines for implementing golden/snapshot testing for complex systems |
248
+
249
+
### TypeScript & JS ecosystem
250
+
251
+
*Also load these when working in TypeScript or JavaScript.*
252
+
253
+
| Name | Description |
254
+
| --- | --- |
255
+
| bun-monorepo-patterns | Modern patterns for Bun-based TypeScript monorepo architecture |
256
+
| electron-app-development-patterns | Guidelines for Electron development ecosystems including npm, pnpm, and Bun, with security baselines and framework comparisons |
242
257
| pnpm-monorepo-patterns | Modern patterns for pnpm-based TypeScript monorepo architecture |
243
-
| python-cli-patterns | Modern patterns for Python CLI application architecture |
244
-
| python-modern-guidelines | Guidelines for modern Python projects using uv, with a few more opinionated practices |
245
-
| python-rules | General Python coding rules and best practices |
246
-
| release-notes-guidelines | Guidelines for writing clear, accurate release notes |
247
-
| supply-chain-hardening | Strongly recommended for EVERY repo — apply it if a repo has not been hardened yet. Cross-ecosystem policy for installing dependencies safely (the 14-day cool-off, disabled install scripts, lockfile discipline, untrusted-repo handling). Use whenever a user mentions hardening, security, supply chain, or setting up a new repo; before adding/upgrading dependencies; when auditing for compromised packages; or when reviewing install/build/run commands across npm/pnpm, PyPI, Cargo, or Go. |
248
-
| tbd-sync-troubleshooting | Common issues and solutions for tbd sync and workspace operations |
249
258
| typescript-cli-tool-rules | Rules for building CLI tools with Commander.js, picocolors, and TypeScript |
250
259
| typescript-code-coverage | Best practices for code coverage in TypeScript with Vitest and v8 provider |
251
260
| typescript-rules | TypeScript coding rules and best practices |
252
261
| typescript-sorting-patterns | Deterministic sorting patterns and comparison chains for TypeScript |
253
262
| typescript-yaml-handling-rules | Best practices for parsing and serializing YAML in TypeScript |
254
263
264
+
### Python
265
+
266
+
*Also load these when working in Python.*
267
+
268
+
| Name | Description |
269
+
| --- | --- |
270
+
| python-cli-patterns | Modern patterns for Python CLI application architecture |
271
+
| python-modern-guidelines | Guidelines for modern Python projects using uv, with a few more opinionated practices |
272
+
| python-rules | General Python coding rules and best practices |
273
+
274
+
### Convex
275
+
276
+
*Also load these when working with Convex.*
277
+
278
+
| Name | Description |
279
+
| --- | --- |
280
+
| convex-limits-best-practices | Comprehensive reference for Convex platform limits, workarounds, and performance best practices |
281
+
| convex-rules | Guidelines and best practices for building Convex projects, including database schema design, queries, mutations, and real-world examples |
282
+
283
+
### Docs, process & tooling
284
+
285
+
| Name | Description |
286
+
| --- | --- |
287
+
| cli-agent-skill-patterns | How to write skills and agent-integrated CLIs that work across Claude Code, Codex, and the broader coding-agent ecosystem—a simple baseline plus references for advanced, multi-subcommand tools |
288
+
| common-doc-guidelines | Common cross-project standards for writing and organizing docs, code comments, and text files—how to organize, structure, write, and format documents, plus the guideline footer convention. Downstream of github.com/jlevy/practical-prose. Use whenever writing or editing any documentation, README, guideline, or design doc. |
289
+
| release-notes-guidelines | Guidelines for writing clear, accurate release notes |
290
+
| supply-chain-hardening | Strongly recommended for EVERY repo—apply it if a repo has not been hardened yet. Cross-ecosystem policy for installing dependencies safely (the 14-day cool-off, disabled install scripts, lockfile discipline, untrusted-repo handling). Use whenever a user mentions hardening, security, supply chain, or setting up a new repo; before adding/upgrading dependencies; when auditing for compromised packages; or when reviewing install/build/run commands across npm/pnpm, PyPI, Cargo, or Go. |
291
+
| tbd-sync-troubleshooting | Common issues and solutions for tbd sync and workspace operations |
4.**Shortcuts**: Reusable instruction templates for common workflows (code review,
23
23
commits, PRs, cleanup, handoffs).
@@ -79,6 +79,7 @@ or want help → run `tbd shortcut welcome-user`
79
79
| “Create a PR” / “File a PR” |`tbd shortcut create-or-update-pr-simple`|
80
80
| “Merge main into my branch” |`tbd shortcut merge-upstream`|
81
81
|**Guidelines & Knowledge**||
82
+
|*(any engineering work)*| Load the **General engineering** group first (see below) |
82
83
| “Use TypeScript best practices” |`tbd guidelines typescript-rules`|
83
84
| “Use Python best practices” |`tbd guidelines python-rules`|
84
85
| “Build a TypeScript CLI” |`tbd guidelines typescript-cli-tool-rules`|
@@ -97,6 +98,12 @@ or want help → run `tbd shortcut welcome-user`
97
98
| “Check out this library’s source” |`tbd shortcut checkout-third-party-repo`|
98
99
|*(your choice whenever appropriate)*|`tbd list`, `tbd dep add`, `tbd close`, `tbd sync`, etc. |
99
100
101
+
**Loading guidelines for engineering work:** Before writing or reviewing code, load the
102
+
**General engineering** group—the `general-*` rules plus `error-handling-rules`—since
103
+
these apply to all code regardless of language.
104
+
Then load the group for the language or framework in use (TypeScript, Python, Convex,
105
+
etc.). Run `tbd guidelines --list` to see all available guidelines.
106
+
100
107
**Note:** Never gitignore `.tbd/workspaces/` — the outbox must be committed to your
101
108
working branch. See `tbd guidelines tbd-sync-troubleshooting` for details.
102
109
@@ -220,36 +227,67 @@ Run `tbd shortcut <name>` to use any of these shortcuts:
220
227
221
228
## Available Guidelines
222
229
223
-
Run `tbd guidelines <name>` to apply any of these guidelines:
230
+
Run `tbd guidelines <name>` to apply any of these guidelines.
231
+
Load the **General engineering** group first, then the language or framework group.
232
+
233
+
### General engineering
234
+
235
+
*Read all of these for any engineering work (writing or reviewing code).*
224
236
225
237
| Name | Description |
226
238
| --- | --- |
227
239
| backward-compatibility-rules | Guidelines for maintaining backward compatibility across code, APIs, file formats, and database schemas |
228
-
| bun-monorepo-patterns | Modern patterns for Bun-based TypeScript monorepo architecture |
229
-
| cli-agent-skill-patterns | How to write skills and agent-integrated CLIs that work across Claude Code, Codex, and the broader coding-agent ecosystem — a simple baseline plus references for advanced, multi-subcommand tools |
230
240
| commit-conventions | Conventional Commits format with extensions for agentic workflows |
231
-
| common-doc-guidelines | Common cross-project standards for writing and organizing docs, code comments, and text files — how to organize, structure, write, and format documents, plus the guideline footer convention. Downstream of github.com/jlevy/practical-prose. Use whenever writing or editing any documentation, README, guideline, or design doc. |
232
-
| convex-limits-best-practices | Comprehensive reference for Convex platform limits, workarounds, and performance best practices |
233
-
| convex-rules | Guidelines and best practices for building Convex projects, including database schema design, queries, mutations, and real-world examples |
234
-
| electron-app-development-patterns | Guidelines for Electron development ecosystems including npm, pnpm, and Bun, with security baselines and framework comparisons |
235
241
| error-handling-rules | Rules for handling errors, failures, and exceptional conditions |
236
242
| general-coding-rules | Rules for constants, magic numbers, and general coding practices |
| general-eng-assistant-rules|Rules for AI assistants acting as senior engineers, including objectivity and communication guidelines|
244
+
| general-eng-agent-principles|Core principles for AI agents acting as senior engineers—objectivity and communication conduct plus the engineering process (detailed understanding, verification, end-to-end ownership, scope discipline, tracking future work, and acting versus seeking clarification)|
239
245
| general-tdd-guidelines | Test-Driven Development methodology and best practices |
240
246
| general-testing-rules | Rules for writing minimal, effective tests with maximum coverage |
241
247
| golden-testing-guidelines | Guidelines for implementing golden/snapshot testing for complex systems |
248
+
249
+
### TypeScript & JS ecosystem
250
+
251
+
*Also load these when working in TypeScript or JavaScript.*
252
+
253
+
| Name | Description |
254
+
| --- | --- |
255
+
| bun-monorepo-patterns | Modern patterns for Bun-based TypeScript monorepo architecture |
256
+
| electron-app-development-patterns | Guidelines for Electron development ecosystems including npm, pnpm, and Bun, with security baselines and framework comparisons |
242
257
| pnpm-monorepo-patterns | Modern patterns for pnpm-based TypeScript monorepo architecture |
243
-
| python-cli-patterns | Modern patterns for Python CLI application architecture |
244
-
| python-modern-guidelines | Guidelines for modern Python projects using uv, with a few more opinionated practices |
245
-
| python-rules | General Python coding rules and best practices |
246
-
| release-notes-guidelines | Guidelines for writing clear, accurate release notes |
247
-
| supply-chain-hardening | Strongly recommended for EVERY repo — apply it if a repo has not been hardened yet. Cross-ecosystem policy for installing dependencies safely (the 14-day cool-off, disabled install scripts, lockfile discipline, untrusted-repo handling). Use whenever a user mentions hardening, security, supply chain, or setting up a new repo; before adding/upgrading dependencies; when auditing for compromised packages; or when reviewing install/build/run commands across npm/pnpm, PyPI, Cargo, or Go. |
248
-
| tbd-sync-troubleshooting | Common issues and solutions for tbd sync and workspace operations |
249
258
| typescript-cli-tool-rules | Rules for building CLI tools with Commander.js, picocolors, and TypeScript |
250
259
| typescript-code-coverage | Best practices for code coverage in TypeScript with Vitest and v8 provider |
251
260
| typescript-rules | TypeScript coding rules and best practices |
252
261
| typescript-sorting-patterns | Deterministic sorting patterns and comparison chains for TypeScript |
253
262
| typescript-yaml-handling-rules | Best practices for parsing and serializing YAML in TypeScript |
254
263
264
+
### Python
265
+
266
+
*Also load these when working in Python.*
267
+
268
+
| Name | Description |
269
+
| --- | --- |
270
+
| python-cli-patterns | Modern patterns for Python CLI application architecture |
271
+
| python-modern-guidelines | Guidelines for modern Python projects using uv, with a few more opinionated practices |
272
+
| python-rules | General Python coding rules and best practices |
273
+
274
+
### Convex
275
+
276
+
*Also load these when working with Convex.*
277
+
278
+
| Name | Description |
279
+
| --- | --- |
280
+
| convex-limits-best-practices | Comprehensive reference for Convex platform limits, workarounds, and performance best practices |
281
+
| convex-rules | Guidelines and best practices for building Convex projects, including database schema design, queries, mutations, and real-world examples |
282
+
283
+
### Docs, process & tooling
284
+
285
+
| Name | Description |
286
+
| --- | --- |
287
+
| cli-agent-skill-patterns | How to write skills and agent-integrated CLIs that work across Claude Code, Codex, and the broader coding-agent ecosystem—a simple baseline plus references for advanced, multi-subcommand tools |
288
+
| common-doc-guidelines | Common cross-project standards for writing and organizing docs, code comments, and text files—how to organize, structure, write, and format documents, plus the guideline footer convention. Downstream of github.com/jlevy/practical-prose. Use whenever writing or editing any documentation, README, guideline, or design doc. |
289
+
| release-notes-guidelines | Guidelines for writing clear, accurate release notes |
290
+
| supply-chain-hardening | Strongly recommended for EVERY repo—apply it if a repo has not been hardened yet. Cross-ecosystem policy for installing dependencies safely (the 14-day cool-off, disabled install scripts, lockfile discipline, untrusted-repo handling). Use whenever a user mentions hardening, security, supply chain, or setting up a new repo; before adding/upgrading dependencies; when auditing for compromised packages; or when reviewing install/build/run commands across npm/pnpm, PyPI, Cargo, or Go. |
291
+
| tbd-sync-troubleshooting | Common issues and solutions for tbd sync and workspace operations |
0 commit comments