周报生成技能

Git のコミット履歴を自動的に読み取り、プロジェクトごとにグループ化して構造化された週報を生成します。

機能特性

• Git のコミット履歴を自動的に読み取る
• 複数のリポジトリの集計をサポート
• 現在のユーザーを自動的に識別 (git config user.name)
• プロジェクトごとにグループ化し、構造化された週報を生成
• 瑣末なコミットをフィルタリング（typo、merge、format など）
• 補足説明の追加をサポート
• 週報は ~/.weekly-reports/ ディレクトリに一括して保存

使用方式

基本用法

任意の Git プロジェクトディレクトリで以下を実行します。

/weekly-report

実行流程

1. 時間範囲の選択

   • 本週 (具体的な日付を表示、例: 2026-01-06 ~ 2026-01-12)
   • 上週 (具体的な日付を表示、例: 2025-12-30 ~ 2026-01-05)
   • 前半年 (具体的な日付を表示、例: 2025-07-13 ~ 2026-01-13)
   • カスタム週報（月曜日の日付を入力）
   • カスタム期間（開始日を入力、本日まで）

   重要：選択時には具体的な日付範囲を必ず表示し、ユーザーが正しいか確認できるようにする

2. リポジトリの選択（複数のリポジトリが設定されている場合）

   • 設定済みのリポジトリのリストを表示
   • 含めるリポジトリを複数選択可能
   • 現在のディレクトリを新しいリポジトリとして追加可能

3. 補足内容の追加（任意）

   • 追加の作業内容を入力
   • 例：会議への参加、技術共有など

4. 週報の生成

   • 選択されたリポジトリの Git コミットを読み取る（すべてのブランチ/リモート追跡ブランチを網羅する必要がある、コミットの漏れを防ぐため）
   • プロジェクトごとにグループ化
   • 瑣末なコミットをフィルタリング
   • Markdown 形式の週報を生成
   • 週報の本文末尾に自動的に「下週計画」テンプレートを追加（出力形式を参照）
   • 週報は ~/.weekly-reports/{year}/week-{week}.md に保存
   • 期間報告は ~/.weekly-reports/periods/{start_date}_to_{end_date}.md に保存

Git コミットの読み取り（重要）

「現在のブランチのみを読み取り、他のブランチ（例えば credits-lite*）を読み飛ばしてしまう」という問題を避けるため、コミットを読み取る際には --all（ローカルブランチ + リモート追跡ブランチを網羅）を使用し、終了日が終了日当日を含むようにする必要があります。

# 关键点：
# - 用 --all 覆盖所有本地 refs（包含 remotes/origin/*）
# - --until 用 “结束日 23:59:59” 避免漏掉结束日当天提交
# - --author 建议用 name + email 联合匹配，避免不同身份写法漏掉本人提交

AUTHOR_PATTERN="(your-name|your@email.com)"  # 或仅用你的 name/email
git log --all \
  --author="$AUTHOR_PATTERN" \
  --since="$START_DATE 00:00:00" \
  --until="$END_DATE 23:59:59" \
  --pretty=format:"%H|%s|%an|%ad" \
  --date=short

git branch -a で対象のリモートブランチが見えない場合（ローカルに対応するリモート追跡参照がないことを意味します）、最初に git fetch --all --prune を実行する必要があります（ユーザーが同意し、ネットワークが利用可能な場合に実行）。そうしないと、「ローカルに存在しないブランチ」のコミットを読み取ることができません。

出力形式

週報は階層リスト構造を採用し、日付範囲のタイトルを必ず含める必要があります。プロジェクトごとにグループ化します。

週報形式

# 周报 (2026-01-06 ~ 2026-01-12)

项目名称
  - 主要工作点（10字以内）
    - 补充说明（可选）
  - 另一个工作点

其他
  - 不属于特定项目的工作内容

下周计划
项目名称
-

時間段報告形式

期間報告には「下週計画」テンプレートは追加されません（週単位ではないため）。

# 工作总结 (2025-07-13 ~ 2026-01-13)

项目名称
  - 主要工作点（10字以内）
    - 补充说明（可选）
  - 另一个工作点

其他
  - 不属于特定项目的工作内容

「下週計画」テンプレートのルール

週報の本文が生成された後、末尾に「下週計画」ブロックを追加します。

1. タイトル行は固定で 下周计划（# プレフィックスなし、プロジェクト名と同レベル）
2. 今週の週報の本文から、出現したすべてのプロジェクト名（「其他」を除く）を、元の順序でリストアップ
3. 各プロジェクト名の下に1行の - をプレースホルダーとして配置し、ユーザーが後で入力できるようにする
4. ユーザーがインタラクション中に積極的に下週の計画内容を提供した場合、対応するプロジェクトの下に直接入力し、プレースホルダーは使用しない

示例输出

# 周报 (2026-01-06 ~ 2026-01-12)

project-frontend
  - 构建工具升级改造
  - 核心功能开发流程跟进
    - 方案合理性优化
  - 脚本国际化优化

project-backend
  - 自定义类型化消息渲染
  - 断线重连流程梳理

其他
  - 新版国际化方案讨论

下周计划
project-frontend
-
project-backend
-

配置文件

設定ファイルは ~/.weekly-reports/config.json にあります。

{
  "repos": [
    {
      "name": "project-a",
      "path": "/home/user/projects/project-a"
    },
    {
      "name": "project-b",
      "path": "/home/user/projects/project-b"
    }
  ],
  "default_author": "auto",
  "output_format": "markdown"
}

总结原则

必须遵守

• 事実導向：実際に完了した作業のみをまとめる
• 简洁精炼：主要な作業点は 10 字以内に抑える
• 重点突出：瑣末な修正はフィルタリングする
• 按项目分组：同じプロジェクトの作業は分類する
• 层级清晰：インデントを使用して従属関係を示す

过滤规则

以下のコミットは個別にリストアップされません。

• 純粋なフォーマット/コードスタイルの調整
• 簡単な typo 修正
• 依存関係のバージョンの小幅な更新
• Merge コミット
• 繰り返し発生する類似のコミット

詳細な形式仕様については、周报格式规范 を参照してください。