CONTRIBUTING.md

Steins;Gitにようこそ！この文章を読んでくださっているということは、Steins;Gitに対し、なんらかの貢献をしたいと思い、読んでくださっていることだろうと思います。ここでは、貢献のためのヒントを書いていこうと思います。

はじめに

Steins;GitはSteins;Gateの二次創作物となります。そのため貢献をする前に著作物転載ガイドライン｜ニトロプラスNitroplusと二次創作活動における同人誌等の活動に関する取り扱いについて｜ニトロプラスNitroplusを読み、これらに遵守した形で貢献をしていただけるようお願いします。

Steins;Gitに主に関わっている人

• kubosho
  • 執筆者
• fruitsnoodle
  • Git初心者の立場から本をレビュー
  • イラストの発注
  • 各種調査
• GiantRobot
  • 表紙・各章の挿絵担当

Steins;Gitの執筆方針について

Steins;Gitは「Gitの使い方を、Steins;Gateの世界観を使って説明する」書籍です。「Steins;Gateのストーリーの流れに沿って、Gitの説明をする」書籍ではありません。

簡潔に書くと「シュタゲ本」というよりは「技術書」よりです。

とはいえ、なるべくSteins;Gateを絡めていきたいですし、全体の雰囲気もSteins;Gateっぽくしたいとは思っています。

Steins;Gitの対象読者について

対象の読者は以下の通りとなります。

• Steins;Gateのアニメを全話見た、もしくはゲームで全てのエンディングを見た人
• Gitを触れたことがない、もしくは、Gitを触り始めたばかりの人

Steins;Gitの様々なやりとりについて

何か決めないといけなかったり、新規に執筆する際は、IssuesからIssueを立てて、そのIssue内でやりとりをします。

新たな章や節を追加する際のガイドライン

1. まずIssueを立てます。タイトルは「[ChX-x] 章や節のタイトル」という形式にします。(例: [Ch1-3] 集中型バージョン管理)

• 必ず「writing」というラベルをつけます。

2. 新たにbranchを作ります。branch名は「feature/id/:issue-id」という形式にします。
3. 執筆します。
4. Pull Requestをmasterに対して出します。出来るかぎりレビューしてからマージという形をとります。

誤字脱字を直す際のガイドライン

• 誤字脱字を直す際は、Issueを立てていただれば、こちら側で直します。
• Pull Requestを出していただける場合は、出来るだけbranchを別で作って、そちらで直していただけると幸いです。あとは、特に問いません。ありがとうございます！

ディレクトリの命名規則について

• Ch*/
  • 各章と節を書いたAsciidoc形式のファイルが格納されています。各ディレクトリには必ずreadme.adocがあり、そこで各節をincludeしています。
• Ch*/img
  • 各章や節で使う画像が格納されています。

自分のPC上でSteins;Gitを確認したい場合について

README.mdをご覧ください。

コミットメッセージについて

azu/release-changelogにより、CHANGELOG.mdを自動生成するため、以下のルールに沿った形で書くことを推奨します。

conventional-changelog/CONVENTIONS.md at master · ajoslin/conventional-changelog

azu/promises-bookと同じく、feat, write, fix, docsというのをコミットメッセージ内に含めることにより、CHANGELOGの対象になります。

とはいえ、分からない場合はとりあえずchoreを使ったり、他のコミットメッセージを使っても大丈夫です。