貢献方法のドキュメント

README.md

@@ -1 +1,45 @@
-## osdev-jp.github.io
+# osdev-jp
+
+osdev-jp では、OS 開発に有用な情報を収集し公開しています。また、OS を自作している人たちのためのコミュニティであることも目指しています。
+
+## 主なリソース
+
+- [Wiki](https://github.com/osdev-jp/osdev-jp.github.io/wiki) : メインコンテンツです。自作 OS に関する各種の情報を集積しています。
+- [GitHub](https://github.com/osdev-jp) : GitHub リポジトリです。サンプルソースなどを提供しています。
+
+## 貢献方法
+
+osdev-jp に興味があり、Wiki の加筆やソースコードの提供をしていただける場合は、いくつかの貢献方法があります。
+
+- 誤字・脱字などを報告する、加筆する
+    - Wiki に対する修正の場合は [issues](https://github.com/osdev-jp/osdev-jp.github.io/issues) に登録してくだされば誰かが対応するでしょう。
+    - 修正が大きく、issues では表現が難しい場合は、ご自分の GitHub リポジトリに osdev-jp.github.io.wiki.git を「フォーク」し、修正したものへのリンクを issues に張り付けてください。（詳しいやり方は後述）
+    - その他のソースコードに対する修正は Pull Request を送ってください。
+- ソースコードを提供する
+    - ご自分の GitHub リポジトリにソースコードをアップロードし、issues で教えてくだされば、Wiki にリンクを載せるなどの対応をさせていただきます。
+    - 必ずしも採用されるとは限りませんのでご了承ください。
+- コミュニティメンバーになって活動する
+    - がしがし記事を書いたりソースコードをアップロードしたい場合、osdev-jp のメンバーになっていただくとスムーズです。
+    - メンバー（GitHub 用語では「コントリビュータ」）になるにはコアメンバーによる審査が必要です。issues に「メンバー登録申請」などというタイトルで新規 issue を登録してくだされば、コアメンバーが審査させていただきます。（詳しくは後述）
+
+## osdev-jp の Wiki リポジトリを「フォーク」して「プルリク」を出す
+
+GitHub では他人が所有するリポジトリを自分のリポジトリにコピーすることを「フォーク」と呼びます。他人が作ったソフトウェアを改造したいけど、直接 push する権限はないときに、一旦自分のリポジトリにコピーして修正することがよくあります。
+
+しかし、GitHub の Wiki は一つのリポジトリであるにも関わらず、フォークすることはできません。ここでは少々トリッキーな方法で、手動で「フォーク」します。
+
+1. 自分の GitHub アカウントでフォーク先となるリポジトリを作ります。ここでは `osdev-jp-wiki` と呼びます。
+2. ローカルマシンに osdev-jp の Wiki リポジトリをクローンします。`$ git clone [email protected]:osdev-jp/osdev-jp.github.io.wiki.git`
+3. `origin` が指す先を `osdev-jp` から自分のアカウントに変えます。`$ git remote set-url origin git://github.com/<アカウント名>/osdev-jp-wiki.git`
+4. Wiki ソースに変更を加えたのち、push します。`$ git push -u origin master`
+5. osdev-jp の issues にマージ要請のチケットを新規作成してください。コミットへのリンクを忘れずに！
+
+## コミュニティメンバーになる
+
+コミュニティメンバーになるには簡単な審査を経る必要があります。誰でもメンバーになれるわけではありません。osdev-jp はメンバーに対し、OS 自作に関する活動をしていることや有用な情報を提供してくれることなどを求めます。
+
+これは、荒らし対策でもあり、常に活発なメンバーのみが参加していてほしいという願いでもあります。いたずらに制限をかけたいわけではありません。活動意欲がある方なら大歓迎ですので、お気軽に参加申請を送っていただけると幸いです。
+
+1. [issues](https://github.com/osdev-jp/osdev-jp.github.io/issues) に「メンバー登録要請」などというタイトルでチケットを発行してください。既存のメンバーが、その人をメンバーとして迎え入れるか話し合って結論を出します。何か、今までの活動が分かるプレゼン資料やソースコードなどがあれば、ぜひリンクを張っていただきたいです。また「osdev-jp のメンバーになったらやりたいこと」を表明していただけるとより良いでしょう。
+2. 審査が通ると晴れて osdev-jp のメンバーになれます。システム的には GitHub リポジトリの「コントリビュータ」に追加することをもってメンバー登録となります。その後は既存メンバーと一緒に、記事を書いたりプログラミングしたり、自由に活動していただけます。
+3. しばらくの間、活動が休止しているように見えるメンバーについては、一旦メンバーの登録を解除させていただくことがあります。osdev-jp を盛り上げていくための措置ですので、あらかじめご了承ください。登録解除に関する詳しいルールは、現在議論中です。