Newer
Older
TelosDB / CONTRIBUTING.md
@楽曲作りまくりおじさん 楽曲作りまくりおじさん 17 hours ago 1 KB chore: add CONTRIBUTING, update .gitignore, add pre-commit guard hook

CONTRIBUTING

このリポジトリへの貢献ルール(開発者向け簡略版)

目的

  • 重要ファイルの誤削除や機密情報の誤コミットを防ぎ、安定した開発ワークフローを保つ。

必須ルール

  1. 機密ファイルはリポジトリにコミットしない

    • .env, .env.* 等の環境変数ファイルやシークレットは常にローカルに置き、.gitignore に追加すること。
  2. 破壊的操作は明示的承認を要する

    • ファイル/ディレクトリの大量削除や重要ディレクトリ(docs/, src/backend/ 等)への削除は、プルリクエストでレビューを行い、明示的承認を得てからマージすること。
  3. コミット前チェック

    • コミット前に git status を必ず確認すること。
    • pre-commit フックをリポジトリの core.hooksPath として有効化することを推奨する(方法は下記)。
  4. フックの有効化(手順)

    • 初回セットアップ時にローカルで以下を実行して下さい:
# リポジトリルートで実行
git config core.hooksPath .githooks

これにより .githooks/pre-commit が実行され、危険な操作の自動検出を行います。

  1. 一時ファイル扱いのルール

    • 一時ファイル(*.tmp, *.bak, editor swap など)は .gitignore に含める。
    • リポジトリ外の生成物(node_modules, target/, dist/ など)はコミットしない。
  2. ジャーナル記録

    • 重要な作業(破壊的操作など)は journals/ に記録し、コミットに関連付けることを推奨。

このファイルはプロジェクトの貢献ルールの最低セットです。必要に応じて運用ルールを拡張してください。