Knowledge Bundle

Bundle OKF 0.1 · 6 conceitos · hanamizuno/pnpm-biome-template

Open source Repository Open in the app JSON README (API)

About

# Knowledge Bundle

[Open Knowledge Format (OKF) v0.1](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) 準拠の知識バンドル。AI エージェントと人間が共有メモリとして読み書きする。

`README.md`（ユーザー向け）や `AGENTS.md`（エージェント向けガイドライン）とは異なり、ここには **コードや git 履歴から復元できない意思決定・背景・運用知見** を置く。コードベースや `git log` から読み取れる情報は書かない。

テンプレートにはスケルトンとサンプルのみ同梱しているので、プロジェクトが育ったら実コンテンツで置き換える。

## レイアウト

* [architecture/](architecture/) — システム構造・データフロー・ビルド計画
* [adr/](adr/) — Architecture Decision Records（決定とその理由）
* [conventions/](conventions/) — リポジトリ横断の取り決め
* [runbooks/](runbooks/) — 障害対応・定型運用の手順
* [research/](research/) — 調査・比較検討のスナップショット
* [log.md](log.md) — バンドル全体の更新ログ

## 運用ルール

* `index.md` / `log.md` は予約ファイル名。概念ドキュメントには使わない
* `okf_version` フロントマターを持てるのはバンドルルートの `index.md` のみ
* 他の `.md` は必ずフロントマターを持ち、最低でも `type` を含める。推奨は `type`（必須）・`title`・`description`・`tags`・`timestamp`（ISO 8601）。リソースを指すなら `resource`
* 1 ファイル = 1 概念。階層で親子関係を表す
* リンクはバンドルルート相対（リポジトリ上は `/docs/knowledge/...`）を優先する
* ドキュメントを追加・更新したら該当サブディレクトリの `ind

Details

Kind: OKF bundles
Topic: Version control
Publisher: hanamizuno
Origin: okf_github
Category: dados
Version: 0.1
Open pull requests: 1
Last push: 2026-09-10T05:38:37Z
Repository state: ativo
Language: Shell
License: MIT
Added: 2026-09-09 05:09:53
Updated: 2026-09-09 05:09:53
Origin id: hanamizuno/pnpm-biome-template:docs/knowledge/index.md

README

# pnpm + Biome Template

Node.js + pnpm + Biome の TypeScript プロジェクトテンプレート。

## 機能

- TypeScript / Biome（フォーマット・リント）/ vitest（テスト・ベンチ・カバレッジ 80%）
- pre-commit hooks（biome / typecheck / secretlint）
- GitHub Actions CI: Node 24・25 マトリクス、依存自動更新、PR 自動ラベリング、アクションと Docker ベースイメージの digest 固定
- セキュリティ: secretlint / pnpm audit / Trivy（SARIF を Security タブへ）、CycloneDX SBOM、hadolint / actionlint / zizmor
- AI エージェント実行環境: Dev Container（Claude Code / Codex / OpenCode / Pi + Chrome DevTools MCP）と [Docker Sandboxes](https://docs.docker.com/ai/sandboxes/) 用 kit（`.sandbox/`）

## セットアップ

```bash
corepack enable
pnpm install
```

pnpm のバージョンは `package.json` の `packageManager` から corepack が解決する。pre-commit hooks を使う場合は [prek](https://github.com/j178/prek) をインストールして `prek install`。

## 主なコマンド

```bash
pnpm dev            # tsx --watch で開発実行
pnpm test           # テスト（test:cov でカバレッジ、bench でベンチマーク）
pnpm fmt            # フォーマット適用（lint でリント、check で biome check + typecheck）
pnpm release-check  # CI 相当の一括チェック
pnpm scan:secrets   # シークレット検出
pnpm build          # tsc で dist/ に出力（start で実行）
```

## テンプレート導入手順

1. `package.json` の `name` をプロジェクト名に変更
2. `LICENSE` のプレースホルダ（`[yyyy]` / `[name of copyright owner]`）を記入、またはライセンスごと差し替え
3. `.github/CODEOWNERS` の `@REPLACE-ME` を実在のユーザー / チームに置換
4. `docs/knowledge/` のサンプルを実プロジェクトの知識で差し替え（運用ルールは [docs/knowledge/index.md](docs/knowledge/index.md)）
5. `corepack enable && pnpm install && pnpm release-check` で健全性を確認

## ドキュメント

- [AGENTS.md](AGENTS.md) — ディレクトリ構成・開発規約（AI エージェント向けガイドライン）
- [docs/knowledge/](docs/knowledge/) — 意思決定・背景・運用手順の知識バンドル
  - [Dev Container 運用](docs/knowledge/runbooks/devcontainer.md) — エージェント環境のセットアップ・認証・シークレット
  - [sbx 運用](docs/knowledge/runbooks/agent-sandbox-sbx.md) — microVM 隔離でのエージェント実行

## リリース

`pnpm release-check` → `CHANGELOG.md` 更新 → バージョンタグ作成。

## ライセンス

[MIT](LICENSE)。`LICENSE` 内の `[yyyy] [name of copyright owner]` は派生先で置換すること。

Knowledge Bundle

About

Details

README

More