contracts
Defines the @evidence checklists every maintained ttsc declaration and test answers, and their evidence.config.json wiring. Use when writing or reviewing maintained source or tests, or changing Evidence selection.
- License 许可
- Apache-2.0
- 最近更新
- 2026-11-14
- Stars
- ★ 21
- Forks
- 2
01 前言 Front Matter
- name
- contracts
- description
- Defines the @evidence checklists every maintained ttsc declaration and test answers, and their evidence.config.json wiring. Use when writing or reviewing maintained source or tests, or changing Evidence selection.
02 资源文件 5
- 参考文档common.md1.9 KB
- 参考文档e2e.md1.5 KB
- 参考文档performance.md1.3 KB
- 参考文档portability.md554 B
- 参考文档testing.md1.6 KB
03 SKILL.md 正文
Contracts
Each checklist H2 is a question that every selected declaration answers in its doc comment. A package's evidence.config.json selects the checklists; pnpm evidence checks that answers exist, and review checks that they are true and complete.
| Checklist | Asks about |
|---|---|
| common.md | Method, design, shortcuts, and documentation of production code |
| portability.md | Native filesystem, path, and process boundaries |
| performance.md | Computation cost, reuse, and resource lifetime |
| testing.md | Behavior, expectations, and cases of every test |
| e2e.md | Boundaries, shared preparation, and isolation of E2E tests |
Answering
- Before writing, read the declaration and everything its H2 asks about, such as its callees, callers, tests, and platforms.
- Answer every fact the H2 asks for, from what the code actually does. A partial, generic, or untrue answer is a defect, not a pass.
- If the code falls short of the question, fix the code, and state any gap that remains instead of claiming the requirement is met.
- Write
@evidence contracts/<file>.md#<anchor> <reason>after a blank comment line, and@evidenceExcludethe same way only for an item that does not apply, never for a whole file.
Selection
- From a package,
pnpm exec evidence listandpnpm exec evidence inspect '<target>'show what a selector reaches. - For a declaration the adapter cannot address, keep its native doc comment and place its checklist answers and tags on the nearest supported owner shown by
listandinspect. Claims: 3/4 activemeans a selector matched nothing, without a diagnostic, andCoveragecounts checklist sections, not declarations.- A Go package of unexported declarations, such as
packages/evidence/native, selects no production host, so review covers it. Adeclare module "@ttsc/lint"augmentation reportstypescript-ambient-moduleuntil the adapter resolves it. - Exclude only generated, copied, or dependency material with verified provenance, and omit a pure re-export barrel whose targets span disjoint claims.
- Never narrow a selector or lower a severity to pass the check.
- Enroll tests in the existing Evidence step of
build.yml, and record entries the adapter cannot address, such as anonymous callbacks or dynamic registrations, for review.
Editing The Checklists
Tens of thousands of tags cite their paths and H2s, so adding, renaming, or removing an H2 needs an authorized migration of every answer. Keep one chapter per question.
04 同仓库更多 Skills
contracts
Defines self-acknowledgments for production declarations and tests. Use when implementing or reviewing maintained source, unit tests or E2E tests, or selecting Evidence checklists.
prompting
Writes and trims ttsc's prompts for agents, namely AGENTS.md, CLAUDE.md, and the skills under .agents/skills. Use before changing any of them, together with the documentation skill's writing rules.
alchemy-domain
Build backends with @alchemy.run/domain (domain-driven design on Effect) - turn requirements into aggregates, commands, events, rejections, views, policies, sagas, projections, streams, queries, external systems and Apis; lay them out in a monorepo (domain / server / web packages, kind-suffixed files); test them with stories; host them on Durable Objects (Cloudflare, Rivet or Effect Cluster) with alchemy; and drive them from a foldkit frontend. Use when designing or changing an @alchemy.run/domain model, adding a building block, wiring hosting or a frontend, or reviewing such code.
alchemy-provider
暂无简介
write-docs
暂无简介
release-overnight
暂无简介