OSS Release

このリポジトリはGitHub privateで育て、公開できる状態を保つ。

公開してよいもの

  • コード
  • テンプレート
  • サンプル設定
  • 公開API向けclient
  • 空または合成のexample data
  • Markdown schema
  • Docker/Dev Container定義

公開しないもの

  • PDF原本
  • OCR結果や出版社PDF由来の全文Markdown
  • Zotero exportの実データ
  • APIキー、token、cookie、認証情報
  • 大学資料、個人資料、医療、年金、生活ログ
  • private feeds
  • モリサワ、ヒラギノ等のフォントファイル

公開前チェック

make check
make secrets-check
git grep -i "token\\|secret\\|password\\|api_key"
git status --short

一度でも秘密情報や権利不明の資料をcommitした場合は、その履歴を公開しない。