get-tbd 0.1.29 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -1
- package/dist/bin.mjs +3241 -2326
- package/dist/bin.mjs.map +1 -1
- package/dist/cli.mjs +1503 -791
- package/dist/cli.mjs.map +1 -1
- package/dist/{config-B38rbI9u.mjs → config-BJz1m9eN.mjs} +183 -39
- package/dist/config-BJz1m9eN.mjs.map +1 -0
- package/dist/{config-C0ITTrtc.mjs → config-DlCUMyCG.mjs} +1 -1
- package/dist/docs/README.md +5 -1
- package/dist/docs/SKILL.md +0 -1
- package/dist/docs/guidelines/backward-compatibility-rules.md +4 -0
- package/dist/docs/guidelines/bun-monorepo-patterns.md +20 -4
- package/dist/docs/guidelines/cli-agent-skill-patterns.md +354 -37
- package/dist/docs/guidelines/commit-conventions.md +4 -0
- package/dist/docs/guidelines/common-doc-guidelines.md +234 -0
- package/dist/docs/guidelines/convex-limits-best-practices.md +4 -0
- package/dist/docs/guidelines/convex-rules.md +4 -0
- package/dist/docs/guidelines/electron-app-development-patterns.md +4 -0
- package/dist/docs/guidelines/error-handling-rules.md +4 -0
- package/dist/docs/guidelines/general-coding-rules.md +4 -0
- package/dist/docs/guidelines/general-comment-rules.md +4 -0
- package/dist/docs/guidelines/general-eng-assistant-rules.md +4 -0
- package/dist/docs/guidelines/general-tdd-guidelines.md +4 -0
- package/dist/docs/guidelines/general-testing-rules.md +4 -0
- package/dist/docs/guidelines/golden-testing-guidelines.md +4 -0
- package/dist/docs/guidelines/pnpm-monorepo-patterns.md +27 -6
- package/dist/docs/guidelines/python-cli-patterns.md +4 -0
- package/dist/docs/guidelines/python-modern-guidelines.md +30 -0
- package/dist/docs/guidelines/python-rules.md +4 -0
- package/dist/docs/guidelines/release-notes-guidelines.md +4 -0
- package/dist/docs/guidelines/supply-chain-hardening.md +11 -7
- package/dist/docs/guidelines/tbd-sync-troubleshooting.md +10 -4
- package/dist/docs/guidelines/typescript-cli-tool-rules.md +27 -24
- package/dist/docs/guidelines/typescript-code-coverage.md +11 -7
- package/dist/docs/guidelines/typescript-rules.md +10 -6
- package/dist/docs/guidelines/typescript-sorting-patterns.md +4 -0
- package/dist/docs/guidelines/typescript-yaml-handling-rules.md +7 -3
- package/dist/docs/install/ensure-gh-cli.sh +59 -24
- package/dist/docs/shortcuts/standard/agent-handoff.md +4 -0
- package/dist/docs/shortcuts/standard/checkout-third-party-repo.md +4 -0
- package/dist/docs/shortcuts/standard/code-cleanup-all.md +4 -0
- package/dist/docs/shortcuts/standard/code-cleanup-docstrings.md +4 -0
- package/dist/docs/shortcuts/standard/code-cleanup-tests.md +4 -0
- package/dist/docs/shortcuts/standard/code-review-and-commit.md +4 -0
- package/dist/docs/shortcuts/standard/coding-spike.md +4 -0
- package/dist/docs/shortcuts/standard/create-or-update-pr-simple.md +4 -0
- package/dist/docs/shortcuts/standard/create-or-update-pr-with-validation-plan.md +4 -0
- package/dist/docs/shortcuts/standard/implement-beads.md +4 -0
- package/dist/docs/shortcuts/standard/merge-upstream.md +4 -0
- package/dist/docs/shortcuts/standard/new-architecture-doc.md +4 -0
- package/dist/docs/shortcuts/standard/new-guideline.md +4 -0
- package/dist/docs/shortcuts/standard/new-plan-spec.md +4 -0
- package/dist/docs/shortcuts/standard/new-qa-playbook.md +4 -0
- package/dist/docs/shortcuts/standard/new-research-brief.md +4 -0
- package/dist/docs/shortcuts/standard/new-shortcut.md +4 -0
- package/dist/docs/shortcuts/standard/new-validation-plan.md +4 -0
- package/dist/docs/shortcuts/standard/plan-implementation-with-beads.md +4 -0
- package/dist/docs/shortcuts/standard/precommit-process.md +4 -0
- package/dist/docs/shortcuts/standard/review-code-python.md +4 -0
- package/dist/docs/shortcuts/standard/review-code-typescript.md +4 -0
- package/dist/docs/shortcuts/standard/review-code.md +4 -0
- package/dist/docs/shortcuts/standard/review-github-pr.md +4 -0
- package/dist/docs/shortcuts/standard/revise-all-architecture-docs.md +4 -0
- package/dist/docs/shortcuts/standard/revise-architecture-doc.md +4 -0
- package/dist/docs/shortcuts/standard/setup-github-cli.md +4 -0
- package/dist/docs/shortcuts/standard/sync-failure-recovery.md +4 -0
- package/dist/docs/shortcuts/standard/update-specs-status.md +4 -0
- package/dist/docs/shortcuts/standard/welcome-user.md +4 -0
- package/dist/docs/tbd-closing.md +4 -0
- package/dist/docs/tbd-design.md +109 -68
- package/dist/docs/tbd-docs.md +20 -13
- package/dist/docs/tbd-prime.md +4 -0
- package/dist/docs/templates/architecture-doc.md +4 -0
- package/dist/docs/templates/plan-spec.md +4 -0
- package/dist/docs/templates/qa-playbook.md +4 -0
- package/dist/docs/templates/research-brief.md +4 -0
- package/dist/{id-mapping-Ctfl_nc1.mjs → id-mapping-CFoPVinz.mjs} +1 -1
- package/dist/{id-mapping-CqrrLgeX.mjs → id-mapping-CtfTfGIh.mjs} +146 -122
- package/dist/id-mapping-CtfTfGIh.mjs.map +1 -0
- package/dist/index.d.mts +53 -1
- package/dist/index.mjs +3 -3
- package/dist/{schemas-C8mOQykE.mjs → schemas-f0EcuAVu.mjs} +40 -3
- package/dist/schemas-f0EcuAVu.mjs.map +1 -0
- package/dist/{src-CJyVkC3V.mjs → src-rIE4xSVs.mjs} +3 -3
- package/dist/src-rIE4xSVs.mjs.map +1 -0
- package/dist/tbd +3241 -2326
- package/package.json +1 -1
- package/dist/config-B38rbI9u.mjs.map +0 -1
- package/dist/docs/guidelines/general-style-rules.md +0 -38
- package/dist/docs/guidelines/writing-style-guidelines.md +0 -42
- package/dist/id-mapping-CqrrLgeX.mjs.map +0 -1
- package/dist/schemas-C8mOQykE.mjs.map +0 -1
- package/dist/src-CJyVkC3V.mjs.map +0 -1
|
@@ -7,8 +7,8 @@ author: Joshua Levy (github.com/jlevy) with LLM assistance
|
|
|
7
7
|
|
|
8
8
|
**Last Updated**: 2026-05-21
|
|
9
9
|
|
|
10
|
-
**Tracks**: Vitest `^4.1.7`, `@vitest/coverage-v8` `^4.1.7`. Vitest 5.0 is in
|
|
11
|
-
|
|
10
|
+
**Tracks**: Vitest `^4.1.7`, `@vitest/coverage-v8` `^4.1.7`. Vitest 5.0 is in beta — do
|
|
11
|
+
not adopt yet.
|
|
12
12
|
|
|
13
13
|
**Related**:
|
|
14
14
|
|
|
@@ -86,16 +86,16 @@ Low branch coverage often indicates untested error paths and edge cases.
|
|
|
86
86
|
pnpm add -D vitest@^4.1 @vitest/coverage-v8@^4.1
|
|
87
87
|
```
|
|
88
88
|
|
|
89
|
-
Follow the
|
|
90
|
-
|
|
91
|
-
`pnpm install --frozen-lockfile`.
|
|
89
|
+
Follow the
|
|
90
|
+
[14-day package-age rule](./pnpm-monorepo-patterns.md#supply-chain-mitigation) on every
|
|
91
|
+
upgrade: use `ncu --cooldown 14` or `pnpm install --frozen-lockfile`.
|
|
92
92
|
|
|
93
93
|
### Vitest 4.x changes that affect coverage
|
|
94
94
|
|
|
95
95
|
- **`coverage.all` was removed** in Vitest 4. Use `coverage.include` and
|
|
96
96
|
`coverage.exclude` to define exactly which files are reported.
|
|
97
|
-
- Coverage reporters and v8 provider now ship as part of `@vitest/coverage-v8`
|
|
98
|
-
|
|
97
|
+
- Coverage reporters and v8 provider now ship as part of `@vitest/coverage-v8` aligned
|
|
98
|
+
with the Vitest major version — pin them together.
|
|
99
99
|
|
|
100
100
|
### Example Configuration
|
|
101
101
|
|
|
@@ -194,3 +194,7 @@ Vitest automatically fails when thresholds are not met if configured.
|
|
|
194
194
|
- **Don’t test implementation details**: Focus on public APIs and behavior
|
|
195
195
|
- **Don’t ignore branch coverage**: TypeScript’s type system creates many branches
|
|
196
196
|
- **Don’t exclude too much**: Be selective about exclusions
|
|
197
|
+
|
|
198
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
199
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
200
|
+
-->
|
|
@@ -9,9 +9,9 @@ alwaysApply: true
|
|
|
9
9
|
|
|
10
10
|
**Last Updated**: 2026-05-21
|
|
11
11
|
|
|
12
|
-
**Tracks**: TypeScript `^6.0.3` (stable).
|
|
13
|
-
(`@typescript/native-preview`, binary `tsgo`) is available but **not
|
|
14
|
-
production-ready** — do not adopt for shipped builds.
|
|
12
|
+
**Tracks**: TypeScript `^6.0.3` (stable).
|
|
13
|
+
TypeScript 7.0 Beta (`@typescript/native-preview`, binary `tsgo`) is available but **not
|
|
14
|
+
yet production-ready** — do not adopt for shipped builds.
|
|
15
15
|
|
|
16
16
|
**Related**:
|
|
17
17
|
|
|
@@ -21,9 +21,9 @@ production-ready** — do not adopt for shipped builds.
|
|
|
21
21
|
- [TypeScript Code Coverage](./typescript-code-coverage.md)
|
|
22
22
|
- [pnpm Monorepo Patterns](./pnpm-monorepo-patterns.md) and
|
|
23
23
|
[Bun Monorepo Patterns](./bun-monorepo-patterns.md)
|
|
24
|
-
- [Supply-Chain Mitigation](./pnpm-monorepo-patterns.md#supply-chain-mitigation) —
|
|
25
|
-
|
|
26
|
-
|
|
24
|
+
- [Supply-Chain Mitigation](./pnpm-monorepo-patterns.md#supply-chain-mitigation) — the
|
|
25
|
+
14-day package-age rule applies to every TypeScript dependency (`zod`, `commander`,
|
|
26
|
+
`vitest`, `eslint`, type packages, etc.).
|
|
27
27
|
|
|
28
28
|
## Coding Style
|
|
29
29
|
|
|
@@ -424,3 +424,7 @@ production-ready** — do not adopt for shipped builds.
|
|
|
424
424
|
import { writeFile } from 'atomically';
|
|
425
425
|
await writeFile(filePath, content);
|
|
426
426
|
```
|
|
427
|
+
|
|
428
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
429
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
430
|
+
-->
|
|
@@ -8,9 +8,9 @@ globs: "*.ts"
|
|
|
8
8
|
|
|
9
9
|
**Last Updated**: 2026-05-21
|
|
10
10
|
|
|
11
|
-
**Tracks**: `yaml@^2.8.4` (latest stable; 2026-05-02). The `yaml@3.0.0-1`
|
|
12
|
-
|
|
13
|
-
recommended validation companion.
|
|
11
|
+
**Tracks**: `yaml@^2.8.4` (latest stable; 2026-05-02). The `yaml@3.0.0-1` release is
|
|
12
|
+
tagged `next` (pre-release) — do not adopt yet.
|
|
13
|
+
Zod 4.x is the recommended validation companion.
|
|
14
14
|
|
|
15
15
|
**Related**:
|
|
16
16
|
|
|
@@ -205,3 +205,7 @@ const output = `---\n${stringifyYaml(data)}---\n\n${content}`;
|
|
|
205
205
|
|
|
206
206
|
- For general TypeScript rules, see `tbd guidelines typescript-rules`
|
|
207
207
|
- For error handling patterns, see `tbd guidelines error-handling-rules`
|
|
208
|
+
|
|
209
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
210
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
211
|
+
-->
|
|
@@ -1,17 +1,38 @@
|
|
|
1
1
|
#!/bin/bash
|
|
2
2
|
# Automated GitHub CLI setup for Claude Code sessions
|
|
3
3
|
# This script runs on SessionStart to ensure gh CLI is available and authenticated
|
|
4
|
+
#
|
|
5
|
+
# Supply-chain policy (see SUPPLY-CHAIN-SECURITY.md): the gh version is PINNED to
|
|
6
|
+
# a release at least 14 days old, and every download is verified against a pinned
|
|
7
|
+
# SHA-256 checksum. Do NOT change this to fetch "latest" from the API at runtime;
|
|
8
|
+
# that bypasses the cool-off window. To bump the pin, pick a release that is >=14
|
|
9
|
+
# days old and copy its checksums from:
|
|
10
|
+
# https://github.com/cli/cli/releases/download/v<VERSION>/gh_<VERSION>_checksums.txt
|
|
4
11
|
|
|
5
|
-
set -
|
|
12
|
+
set -euo pipefail
|
|
6
13
|
|
|
7
14
|
# Add common binary locations to PATH
|
|
8
15
|
export PATH="$HOME/.local/bin:$HOME/bin:/usr/local/bin:$PATH"
|
|
9
16
|
|
|
17
|
+
# Pinned gh release (>=14 days old per supply-chain cool-off) and its checksums.
|
|
18
|
+
GH_VERSION="2.92.0"
|
|
19
|
+
|
|
20
|
+
# SHA-256 checksums from gh_2.92.0_checksums.txt, keyed by asset suffix.
|
|
21
|
+
checksum_for() {
|
|
22
|
+
case "$1" in
|
|
23
|
+
linux_amd64.tar.gz) echo "b57848131bdf0c229cd35e1f2a51aa718199858b2e728410b37e89a428943ec4" ;;
|
|
24
|
+
linux_arm64.tar.gz) echo "c2248526dd0160c08d3fccca2332c3c1a07c15a78b23978e77735f1b5a18cfee" ;;
|
|
25
|
+
macOS_amd64.zip) echo "ae9bb327ab0d91071bdada79f8f14034a2a0f19b0e001835a782eafa519d2af0" ;;
|
|
26
|
+
macOS_arm64.zip) echo "b11c54f6bd7d15ed6590475079e5b2fcf36f45d3991a80041b29c9d0cc1f1d07" ;;
|
|
27
|
+
*) echo "" ;;
|
|
28
|
+
esac
|
|
29
|
+
}
|
|
30
|
+
|
|
10
31
|
# Check if gh is already installed
|
|
11
32
|
if command -v gh &> /dev/null; then
|
|
12
33
|
echo "[gh] CLI found at $(which gh)"
|
|
13
34
|
else
|
|
14
|
-
echo "[gh] CLI not found, installing..."
|
|
35
|
+
echo "[gh] CLI not found, installing pinned v${GH_VERSION}..."
|
|
15
36
|
|
|
16
37
|
# Detect platform
|
|
17
38
|
OS=$(uname -s | tr '[:upper:]' '[:lower:]')
|
|
@@ -19,38 +40,52 @@ else
|
|
|
19
40
|
[ "$ARCH" = "x86_64" ] && ARCH="amd64"
|
|
20
41
|
[ "$ARCH" = "aarch64" ] && ARCH="arm64"
|
|
21
42
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
# Get latest version from GitHub API (with fallback)
|
|
25
|
-
GH_VERSION=$(curl -fsSL https://api.github.com/repos/cli/cli/releases/latest 2>/dev/null \
|
|
26
|
-
| grep -o '"tag_name": *"v[^"]*"' | head -1 | sed 's/.*"v\([^"]*\)".*/\1/')
|
|
27
|
-
|
|
28
|
-
# Fallback version if API fails
|
|
29
|
-
GH_VERSION=${GH_VERSION:-2.83.1}
|
|
30
|
-
|
|
31
|
-
echo "[gh] Version: ${GH_VERSION}"
|
|
32
|
-
|
|
33
|
-
# Build download URL based on platform
|
|
43
|
+
# Build the asset suffix and archive type per platform.
|
|
34
44
|
if [ "$OS" = "darwin" ]; then
|
|
35
|
-
|
|
45
|
+
PLATFORM="macOS_${ARCH}.zip"
|
|
36
46
|
ARCHIVE_EXT="zip"
|
|
47
|
+
EXTRACT_DIR="/tmp/gh_${GH_VERSION}_macOS_${ARCH}"
|
|
37
48
|
else
|
|
38
|
-
|
|
49
|
+
PLATFORM="${OS}_${ARCH}.tar.gz"
|
|
39
50
|
ARCHIVE_EXT="tar.gz"
|
|
51
|
+
EXTRACT_DIR="/tmp/gh_${GH_VERSION}_${OS}_${ARCH}"
|
|
40
52
|
fi
|
|
41
53
|
|
|
54
|
+
echo "[gh] Detected platform: ${PLATFORM}"
|
|
55
|
+
|
|
56
|
+
EXPECTED=$(checksum_for "$PLATFORM")
|
|
57
|
+
if [ -z "$EXPECTED" ]; then
|
|
58
|
+
echo "[gh] ERROR: no pinned checksum for platform ${PLATFORM}; refusing to install"
|
|
59
|
+
echo "[gh] Add the checksum from gh_${GH_VERSION}_checksums.txt to this script"
|
|
60
|
+
exit 1
|
|
61
|
+
fi
|
|
62
|
+
|
|
63
|
+
ASSET="gh_${GH_VERSION}_${PLATFORM}"
|
|
64
|
+
DOWNLOAD_URL="https://github.com/cli/cli/releases/download/v${GH_VERSION}/${ASSET}"
|
|
65
|
+
|
|
42
66
|
echo "[gh] Downloading from ${DOWNLOAD_URL}..."
|
|
67
|
+
curl -fsSL -o "/tmp/${ASSET}" "$DOWNLOAD_URL"
|
|
43
68
|
|
|
44
|
-
#
|
|
45
|
-
|
|
69
|
+
# Verify the download against the pinned checksum before extracting.
|
|
70
|
+
if command -v sha256sum &> /dev/null; then
|
|
71
|
+
ACTUAL=$(sha256sum "/tmp/${ASSET}" | awk '{print $1}')
|
|
72
|
+
else
|
|
73
|
+
ACTUAL=$(shasum -a 256 "/tmp/${ASSET}" | awk '{print $1}')
|
|
74
|
+
fi
|
|
75
|
+
if [ "$ACTUAL" != "$EXPECTED" ]; then
|
|
76
|
+
echo "[gh] ERROR: checksum mismatch for ${ASSET}"
|
|
77
|
+
echo "[gh] expected ${EXPECTED}"
|
|
78
|
+
echo "[gh] actual ${ACTUAL}"
|
|
79
|
+
rm -f "/tmp/${ASSET}"
|
|
80
|
+
exit 1
|
|
81
|
+
fi
|
|
82
|
+
echo "[gh] Checksum verified for ${ASSET}"
|
|
46
83
|
|
|
47
84
|
# Extract based on archive type
|
|
48
85
|
if [ "$ARCHIVE_EXT" = "zip" ]; then
|
|
49
|
-
unzip -q "/tmp
|
|
50
|
-
EXTRACT_DIR="/tmp/gh_${GH_VERSION}_macOS_${ARCH}"
|
|
86
|
+
unzip -q "/tmp/${ASSET}" -d /tmp
|
|
51
87
|
else
|
|
52
|
-
tar -xzf "/tmp
|
|
53
|
-
EXTRACT_DIR="/tmp/gh_${GH_VERSION}_${OS}_${ARCH}"
|
|
88
|
+
tar -xzf "/tmp/${ASSET}" -C /tmp
|
|
54
89
|
fi
|
|
55
90
|
|
|
56
91
|
# Install to ~/.local/bin (works in cloud and local)
|
|
@@ -59,7 +94,7 @@ else
|
|
|
59
94
|
chmod +x ~/.local/bin/gh
|
|
60
95
|
|
|
61
96
|
# Clean up
|
|
62
|
-
rm -rf "${EXTRACT_DIR}" "/tmp
|
|
97
|
+
rm -rf "${EXTRACT_DIR}" "/tmp/${ASSET}"
|
|
63
98
|
|
|
64
99
|
echo "[gh] Installed to ~/.local/bin/gh"
|
|
65
100
|
fi
|
|
@@ -72,7 +107,7 @@ if ! command -v gh &> /dev/null; then
|
|
|
72
107
|
fi
|
|
73
108
|
|
|
74
109
|
# Check authentication status
|
|
75
|
-
if [ -n "$GH_TOKEN" ]; then
|
|
110
|
+
if [ -n "${GH_TOKEN:-}" ]; then
|
|
76
111
|
# GH_TOKEN is set, verify it works
|
|
77
112
|
if gh auth status &> /dev/null; then
|
|
78
113
|
echo "[gh] Authenticated successfully"
|
|
@@ -57,3 +57,7 @@ References: packages/llm-pricing/ - see scripts/generate-llms-data.ts and src/_g
|
|
|
57
57
|
|
|
58
58
|
Setup: Run `pnpm install` after pulling (new dependencies added).
|
|
59
59
|
```
|
|
60
|
+
|
|
61
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
62
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
63
|
+
-->
|
|
@@ -48,3 +48,7 @@ need.
|
|
|
48
48
|
- The `attic/` directory is gitignored—cloned repos won’t pollute your project
|
|
49
49
|
- You can clone multiple repos into attic/ as needed
|
|
50
50
|
- Delete cloned repos when done to save disk space
|
|
51
|
+
|
|
52
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
53
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
54
|
+
-->
|
|
@@ -88,3 +88,7 @@ cycle afterwords, fixing all build or test issues.
|
|
|
88
88
|
- Batch database queries instead of individual fetches in loops
|
|
89
89
|
|
|
90
90
|
- Consolidate nested sequential queries into single `Promise.all` call
|
|
91
|
+
|
|
92
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
93
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
94
|
+
-->
|
|
@@ -75,3 +75,7 @@ export function formatContextMarkdown(
|
|
|
75
75
|
4. Review existing docstrings and remove any that are redundant or obvious
|
|
76
76
|
|
|
77
77
|
5. Run linting to ensure no syntax errors
|
|
78
|
+
|
|
79
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
80
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
81
|
+
-->
|
|
@@ -56,3 +56,7 @@ Keep tests that:
|
|
|
56
56
|
4. Remove trivial tests while preserving meaningful coverage
|
|
57
57
|
|
|
58
58
|
5. Run the full test suite to ensure no regressions
|
|
59
|
+
|
|
60
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
61
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
62
|
+
-->
|
|
@@ -42,3 +42,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
42
42
|
CI watch.
|
|
43
43
|
- Only proceed when you see all checks have passed.
|
|
44
44
|
- Confirm to the user that CI has passed.
|
|
45
|
+
|
|
46
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
47
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
48
|
+
-->
|
|
@@ -52,3 +52,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
9. Report findings and recommend next steps.
|
|
55
|
+
|
|
56
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
57
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
58
|
+
-->
|
|
@@ -55,3 +55,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
55
55
|
- Only proceed when you see all checks have passed in the final summary.
|
|
56
56
|
|
|
57
57
|
8. Confirm to the user that CI has passed and the PR is ready for review.
|
|
58
|
+
|
|
59
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
60
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
61
|
+
-->
|
|
@@ -74,3 +74,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
74
74
|
- Only proceed when you see all checks have passed in the final summary.
|
|
75
75
|
|
|
76
76
|
8. Confirm to the user that CI has passed and the PR is ready for review.
|
|
77
|
+
|
|
78
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
79
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
80
|
+
-->
|
|
@@ -28,3 +28,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
28
28
|
4. Repeat this for all beads where you know how to fix them.
|
|
29
29
|
If unsure about a bead, let the user know at the end of all work which beads had
|
|
30
30
|
problems.
|
|
31
|
+
|
|
32
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
33
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
34
|
+
-->
|
|
@@ -28,3 +28,7 @@ Merge upstream changes from origin/main into the current branch.
|
|
|
28
28
|
6. **Verify**: Run formatting, linting, and tests
|
|
29
29
|
- Fix any issues introduced by the merge
|
|
30
30
|
- Commit the merge result
|
|
31
|
+
|
|
32
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
33
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
34
|
+
-->
|
|
@@ -29,3 +29,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
29
29
|
If designing new architecture, iterate with the user on the design.
|
|
30
30
|
|
|
31
31
|
5. Summarize the architecture and ask the user to review.
|
|
32
|
+
|
|
33
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
34
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
35
|
+
-->
|
|
@@ -122,3 +122,7 @@ description: Best practices for designing TypeScript APIs including naming, type
|
|
|
122
122
|
| `{lang}-{topic}-rules` | `typescript-cli-tool-rules` | Specialized patterns |
|
|
123
123
|
| `{domain}-rules` | `convex-rules` | Framework/platform rules |
|
|
124
124
|
| `general-{topic}-rules` | `general-testing-rules` | Language-agnostic rules |
|
|
125
|
+
|
|
126
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
127
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
128
|
+
-->
|
|
@@ -47,3 +47,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
47
47
|
|
|
48
48
|
5. To list beads linked to a spec, use `tbd list --spec` (see `tbd list --help` for
|
|
49
49
|
details on filtering and path matching).
|
|
50
|
+
|
|
51
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
52
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
53
|
+
-->
|
|
@@ -57,3 +57,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
57
57
|
- Mark phases ✅/❌ in the status table after each run
|
|
58
58
|
- Add test results with dates in the “Test Results” section
|
|
59
59
|
- Archive or update playbooks when they become stale
|
|
60
|
+
|
|
61
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
62
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
63
|
+
-->
|
|
@@ -28,3 +28,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
28
28
|
Ask the user for guidance when you need clarification or hit decision points.
|
|
29
29
|
|
|
30
30
|
5. Summarize findings and ask the user to review.
|
|
31
|
+
|
|
32
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
33
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
34
|
+
-->
|
|
@@ -77,3 +77,7 @@ For official shortcuts added to `packages/tbd/docs/shortcuts/standard/`:
|
|
|
77
77
|
- **Guidelines**: Rules to reference (knowledge)
|
|
78
78
|
|
|
79
79
|
See `tbd shortcut new-guideline` for creating guidelines.
|
|
80
|
+
|
|
81
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
82
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
83
|
+
-->
|
|
@@ -85,3 +85,7 @@ This serves as both a testing checklist and a summary for PR reviewers, showing:
|
|
|
85
85
|
- Both
|
|
86
86
|
|
|
87
87
|
6. **Summarize** what’s validated vs what remains for the user to review.
|
|
88
|
+
|
|
89
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
90
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
91
|
+
-->
|
|
@@ -54,3 +54,7 @@ If unclear, ask the user if they want you to create a spec first using
|
|
|
54
54
|
- **Blocker** (`tbd dep add`): Sequential ordering.
|
|
55
55
|
A bead cannot start until its blockers are complete.
|
|
56
56
|
Use for tasks that genuinely depend on prior work.
|
|
57
|
+
|
|
58
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
59
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
60
|
+
-->
|
|
@@ -62,3 +62,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
62
62
|
(See `tbd guidelines commit-conventions` for details.)
|
|
63
63
|
If all checks pass, commit directly.
|
|
64
64
|
Only ask the user if there are unresolved problems.
|
|
65
|
+
|
|
66
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
67
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
68
|
+
-->
|
|
@@ -32,3 +32,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
32
32
|
- List Python-specific issues found (if any) with file:line references
|
|
33
33
|
- Suggest specific fixes
|
|
34
34
|
- Note any Python patterns that should be addressed
|
|
35
|
+
|
|
36
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
37
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
38
|
+
-->
|
|
@@ -32,3 +32,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
32
32
|
- List TypeScript-specific issues found (if any) with file:line references
|
|
33
33
|
- Suggest specific fixes
|
|
34
34
|
- Note any TypeScript patterns that should be addressed
|
|
35
|
+
|
|
36
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
37
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
38
|
+
-->
|
|
@@ -107,3 +107,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
107
107
|
- Otherwise, present the review and ask:
|
|
108
108
|
- **Fix issues**: Create tbd beads for issues and begin fixing
|
|
109
109
|
- **Report only**: Just output the review (no changes)
|
|
110
|
+
|
|
111
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
112
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
113
|
+
-->
|
|
@@ -139,3 +139,7 @@ Create a to-do list with the following items then perform all of them:
|
|
|
139
139
|
- List any beads created (if fixing with beads)
|
|
140
140
|
- Confirm CI status
|
|
141
141
|
- Provide the PR URL
|
|
142
|
+
|
|
143
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
144
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
145
|
+
-->
|
|
@@ -20,3 +20,7 @@ Run `tbd prime` for more on using tbd and current status.
|
|
|
20
20
|
4. Work through each child bead, close when done
|
|
21
21
|
|
|
22
22
|
5. Close epic with summary
|
|
23
|
+
|
|
24
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
25
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
26
|
+
-->
|
|
@@ -28,3 +28,7 @@ Review and update an architecture document to ensure accuracy with current code.
|
|
|
28
28
|
6. **Add Future Considerations section** with:
|
|
29
29
|
- **Open Questions**: Possible bugs, issues, or design uncertainties
|
|
30
30
|
- **Potential Improvements**: Ideas for future enhancements
|
|
31
|
+
|
|
32
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
33
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
34
|
+
-->
|
|
@@ -75,3 +75,7 @@ See `docs/general/agent-setup/github-cli-setup.md` for token creation instructio
|
|
|
75
75
|
| `gh auth status` shows errors | GH_TOKEN not set or invalid |
|
|
76
76
|
| `Bad credentials` | Token expired or lacks permissions |
|
|
77
77
|
| `Resource not accessible` | Token lacks required scopes (need repo, workflow) |
|
|
78
|
+
|
|
79
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
80
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
81
|
+
-->
|
|
@@ -67,3 +67,7 @@ For detailed troubleshooting, workspace usage, and diagnostic commands, see:
|
|
|
67
67
|
```bash
|
|
68
68
|
tbd guidelines tbd-sync-troubleshooting
|
|
69
69
|
```
|
|
70
|
+
|
|
71
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
72
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
73
|
+
-->
|
|
@@ -25,3 +25,7 @@ Review all active specs and ensure tbd issues accurately reflect current progres
|
|
|
25
25
|
`docs/project/specs/done/`
|
|
26
26
|
|
|
27
27
|
5. **Sync**: Run `tbd sync` to push all changes
|
|
28
|
+
|
|
29
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
30
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
31
|
+
-->
|
|
@@ -63,3 +63,7 @@ Here are examples of things you can say and what happens:
|
|
|
63
63
|
|
|
64
64
|
Then ask if they’d like to explore any of tbd’s capabilities or get started on
|
|
65
65
|
something.
|
|
66
|
+
|
|
67
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
68
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
69
|
+
-->
|
package/dist/docs/tbd-closing.md
CHANGED
|
@@ -29,3 +29,7 @@ Every session must end with tbd in a clean state:
|
|
|
29
29
|
**Work is not done until pushed, CI passes, and tbd is synced.**
|
|
30
30
|
|
|
31
31
|
> **Tip**: Run `tbd closing` anytime for this checklist.
|
|
32
|
+
|
|
33
|
+
<!-- This document follows common-doc-guidelines.md.
|
|
34
|
+
See github.com/jlevy/practical-prose and review guidelines before editing.
|
|
35
|
+
-->
|