From b8a9617e0e9f8256e85a30830fa30ddc284d744f Mon Sep 17 00:00:00 2001
From: Kimiyuki Onaka <kimiyuki95@gmail.com>
Date: Fri, 4 Jan 2019 01:28:32 +0900
Subject: [PATCH] NONE: add CONTRIBUTING.md

---
 CONTRIBUTING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..1019769f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,88 @@
+# Contribute Guide / 開発を手伝ってくれる人へ
+
+## language / 言語について
+
+In the source code and documents for end users, we should use English.
+For other place, both English and Japanese are acceptable.
+
+ソースコード中とエンドユーザが目にする部分はすべて英語で書いてください。
+それ以外の部分は英語でも日本語でもかまいません。
+
+## issues / issue について
+
+機能要求やバグ報告は気軽にしてください。
+コードを書くことだけが開発ではありません。
+
+## pull requests / プルリクについて
+
+基本的にはどんなものでも歓迎します。
+
+ただし常にそのまま merge されるとは限らないので注意してください。
+なにかまずいところがあっても修正を要求するだけなので質は問いません (なにか分からないところがあればとりあえずできたところまでで投げてくれてもよいです) が、以下に従っておくと merge されるまでの時間は短くなるでしょう。
+
+-   手元でテストをする
+    -   CI が通らない限りは merge はできません
+-   コーディングスタイルを周囲のコードと合わせる
+-   変更箇所は必要最低限にする
+-   commit は適切に分割する
+-   機能追加をする場合は事前に確認をする
+    -   「そういう機能は入れません」で弾かれてせっかくの実装が無駄になるとお互いに不幸なためです
+
+
+# Internal Structure / 内部構造
+
+## philosophy of design / 設計の方針
+
+第一義は「コンテストで上位を取ることに役立つこと」です。
+特に「ペナルティを出させないこと」に注力しています。
+これを実現する手段として「手動だと間違えたりさぼったりしやすい作業を自動化する」を用いています。
+
+Web scraping をする性質により動作は必然的に不安定であり、これは「ペナルティを出させないこと」の壁となります。
+これへの対応として「誤動作の起こりやすい機能は避ける」「誤動作があったときに誤動作があると気付きやすいようにする」などを重要視しています。
+その実践の例としては「取得したサンプルケースを(ファイルに出力するだけでなく)画面に見やすく表示する」が分かりやすいでしょう。
+そのような画面への出力がない場合、サンプルケースの取得ミスはかなりの時間のロスを引き起すことが知られています。
+
+## module structure
+
+主に以下のような構造です。
+
+-   `onlinejudge/`
+    -   `type.py`: 型はすべてここ
+    -   `dispatch.py`: URL から object を解決する仕組み
+    -   `implementation/`
+        -   `main.py`: 個別のコマンドを呼び出すまでの部分
+        -   `command/`: `download` `submit` などのコマンドの本体が置かれる
+            -   `download.py`
+            -   `submit.py`
+            -   ...
+    -   `service/`: AtCoder, Codeforces などのサービスごとの実装が置かれる
+        -   `atcoder.py`
+        -   `codeforces.py`
+        -   ...
+-   `tests/`: テストが置かれる
+
+## CI
+
+`master` `develop` に関する commit や pull request について CI が走ります。
+型検査とテストの実行を Python 3.5 と 3.6 のふたつについて確認しています。
+
+実行される内容は次の3行なので、これを手元で試せばだいたい同じ結果が得られます。
+あるいは `[WIP]` などと書いて pull request をするのでもよいでしょう。
+
+``` sh
+$ mypy --verbose --ignore-missing-imports oj onlinejudge/**/*.py
+$ make -C docs html
+$ python setup.py test
+```
+
+## deployment
+
+Travis CI から PyPI 上へ upload を仕掛けるように設定されています。
+
+手順:
+
+1.  `onlinejudge/__about__.py` 中の `__version_info__` の値を bump して commit する
+    -   このとき同時に `CHANGELOG.md` も修正する
+    -   例: [3a24dc](https://github.com/kmyk/online-judge-tools/commit/3a24dc64b56d898e387dee56cf9915be3ab0f7e2)
+2.  `v0.1.23` の形で Git tag を打って GitHub 上へ push する
+    -   これにより Travis CI の機能が呼び出され PyPI への upload がなされる