Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 2.73 KB

File metadata and controls

57 lines (37 loc) · 2.73 KB

コントリビューションガイド

株式会社アイティードゥ(ITDO Inc.)の書籍プロジェクトへのご協力ありがとうございます。

📋 コントリビューション方針

非営利コントリビューション

以下のコントリビューションは歓迎いたします。

  • 誤字脱字の修正
  • 技術的な間違いの指摘
  • 翻訳・多言語化
  • アクセシビリティ改善
  • 学習効果向上のための提案

商用利用を伴うコントリビューション

商用目的でのコントリビューション(企業研修での利用等)をお考えの場合は、 事前に commercial_license Issue での相談をお願いいたします。

🤝 コントリビューション手順

  1. Issue作成 - 改善提案や問題報告
  2. Fork & Clone - リポジトリをフォーク
  3. ブランチ作成 - 作業用ブランチを作成
  4. 変更実装 - 修正・改善を実装
  5. プルリクエスト - 変更内容を提出
  6. レビュー - 内容確認・調整
  7. マージ - 変更の取り込み

📁 本文ファイルの場所(編集対象)

本リポジトリでは、本文が複数箇所に存在します。PRでは、内容の不整合が起きないよう、編集対象を意識してください。

  • 執筆用ソース: src/ 配下(原則としてここを正とする)
  • 公開用(GitHub Pages): docs/ 配下(npm run build / scripts/build-simple.js により生成されるビルド成果物)

docs/chapters/ のファイルが2系統ある点について

docs/chapters/ には、互換性のため以下の2つの形式が並存しています(いずれもビルド時に生成されます)。

  • docs/chapters/chapter-NN-*.md(フラットな .md。例: chapter-01-ai-driven-development.md
  • docs/chapters/chapter-NN-*/index.md(ディレクトリ配下の index.md。例: chapter-01-ai-driven-development/index.md

章本文を修正する場合は、原則として src/ 配下の執筆用ソースを編集したうえで npm run build を実行し、docs/ を更新して PR 内で不要な差分が生じないようにしてください(docs/ は通常、直接編集不要です)。

📝 ライセンス同意

コントリビューションを行うことで、以下に同意したものとみなします。

  • コントリビューション内容が CC BY-NC-SA 4.0 で提供されること
  • 株式会社アイティードゥが商用ライセンス契約において当該コントリビューション内容を利用できること

📞 お問い合わせ

株式会社アイティードゥ(ITDO Inc.)
Email: knowledge@itdo.jp