Newer
Older
TelosDB / docs / workflow / issue_management.md

Issue管理ワークフロー (Issue Management Workflow)

このリポジトリにおける Issue の管理および同期に関する運用ルールです。

1. 外部トラッカーとの同期

本プロジェクトでは、上流の Issue トラッカー (GitHub 互換 API) とローカルの Markdown ファイルを同期させて開発を進めます。

  • 同期方向: 原則として上流の Issue トラッカーが正(Source of Truth)です。
  • 自動同期: node tools/scripts/sync_issues.mjs を実行して、リモートの最新状態を docs/issues/ に反映、またはローカルの新規 Issue をリモートに作成します。
  • Git追跡除外: docs/issues/.gitignore により Git 追跡から除外されています。

2. 記述規約

  • 日英併記の義務化:
    • すべての Issue は日本語と英語を併記しなければなりません。
    • 片方の言語だけで記述されている場合は、不足している言語の翻訳を補完してください。

3. クローズとクリーンアップ

  • 手動クローズ:
    • トラッカー API の制約により、スクリプトからの自動クローズは行いません。
    • 作業完了後、ローカル Markdown の stateclosed にして同期スクリプトを実行すると、手動クローズ用のURLが表示されます。
  • ローカルの自動削除:
    • 上流トラッカー側で closed になった Issue は、同期スクリプト実行時にローカルの Markdown ファイルが自動的に削除されます。