プロジェクト

全般

プロフィール

Wiki » 履歴 » バージョン 18

みぞ @mizo0203, 2018/06/24 15:55

1 1 みぞ @mizo0203
# Wiki
2
3 16 みぞ @mizo0203
## 開発環境
4
5
* Python 開発環境のセットアップ
6
    * https://cloud.google.com/python/setup
7
* エディタのインストール
8
    * https://code.visualstudio.com
9
* Python extension for Visual Studio Code のインストール
10
    * https://marketplace.visualstudio.com/items?itemName=ms-python.python
11 18 みぞ @mizo0203
* Flake8 のインストール
12
    * `$ pip3 install flake8`
13
* Visual Studio Code の設定
14
15
16 16 みぞ @mizo0203
17 1 みぞ @mizo0203
## 開発ツール
18
19
* GitHub
20
    * コード管理
21
        * プライベートリポジトリ(後にパブリックへ変更する)
22 5 みぞ @mizo0203
        * 中央集権型ワークフローを採用する
23
            * 中央リポジトリ: https://github.com/mizo0203/google-home-shiritori
24 1 みぞ @mizo0203
* Redmine
25
    * 要件管理
26
    * 不具合管理
27
    * Wiki
28
* Markdown + PlantUML
29
    * ドキュメント作成
30
    * 設計図作成
31
        * ※ Word・Excel・PowerPoint は使用禁止
32 4 みぞ @mizo0203
* CircleCI - 1 コンテナ無料(プライベートリポジトリでも可、ビルド時間 25h/month まで)
33 1 みぞ @mizo0203
    * ビルドチェック
34
    * 静的解析
35
        * Lint - コードの構文チェック 
36
        * FindBugs - 実行時に起こり得るバグの検出
37
    * 【できれば】Programming Tests
38
    * 【できれば】Deploy
39
* Slack
40
    * チャット
41
42
## 利用サービス
43
44
* DialogFlow
45 8 a a
    * [JSONフォーマット](https://dialogflow.com/docs/fulfillment#section-format-of-request-to-the-service)
46 11 みぞ @mizo0203
    * 参考:
47
        * Dialogflow入門 - https://qiita.com/kenz_firespeed/items/0979ceb05e4e3299f313
48
            * > User saysに「明日の福岡を予約」
49
                * 「User says」欄は現在存在しない、「Training phrases」欄に入力する 
50 12 みぞ @mizo0203
            * > 入力内容を元に自動的にEntityが検出されParameterとして設定されました。
51
                * 自動的には検出されないので、単語をクリックして Entity を追加すること
52
                * `@sys.date` は「明日の」ではなく「明日」を指定すること
53 11 みぞ @mizo0203
        * Dialogflowの使い方について - http://hiyo-ac.hatenablog.com/entry/2018/02/25/162729
54 1 みぞ @mizo0203
55
## 開発フロー
56
57
1. Redmine にチケットを作成
58
2. GitHub で各自ブランチを切って Commit & Push
59 2 みぞ @mizo0203
    * プリフィックス(範囲) + 英語のコミットメッセージ + #チケット番号 + @作業時間
60 14 みぞ @mizo0203
        * ```feat(*): hogehoge. fix #999 @1.5h``` :新しい機能
61
        * ```fix(*): hogehoge. fix #999 @1.5h``` :バグフィックス
62
        * ```docs(*): hogehoge. fix #999 @1.5h [ci skip]``` :ドキュメントのみ変更(CI は実行しない)
63
        * ```style(*): hogehoge. fix #999 @1.5h``` :コードの意味に影響を与えない変更(空白、フォーマット、セミコロンの欠落など)
64
        * ```refactor(*): hogehoge. fix #999 @1.5h``` :バグを修正したり、機能を追加したりしないコード変更
65
        * ```perf(*): hogehoge. fix #999 @1.5h``` :パフォーマンスを向上させるコード変更
66
        * ```test(*): hogehoge. fix #999 @1.5h``` :既存のテストの欠落または修正の追加
67
        * ```chore(*): hogehoge. fix #999 @1.5h``` :ビルドプロセスやドキュメント作成などの補助ツールやライブラリの変更
68 2 みぞ @mizo0203
            * 参考: [【今日からできる】コミットメッセージに 「プレフィックス」 をつけるだけで、開発効率が上がった話 - Qiita](https://qiita.com/numanomanu/items/45dd285b286a1f7280ed)
69
            * 参考: [angular.js/DEVELOPERS.md at master · angular/angular.js](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type)
70
    * 原則 1 Commit 1 チケット
71 15 みぞ @mizo0203
        * ```fix(*): hogehoge. ref #999 @1h``` :対処未完了で Commit する場合
72
        * ```fix(*): hogehoge. fixs #99 @0.5h #999 @1h``` :例外的に複数チケットを 1 Commit で対処する場合
73 2 みぞ @mizo0203
3. CircleCI でビルドチェック、静的解析、PT
74
4. みぞ + 1 名の 2 名でコードレビュー & マージ
75
5. CircleCI でビルドチェック、静的解析、PT、Deploy
76 1 みぞ @mizo0203
77
## 開発言語
78
79 17 みぞ @mizo0203
Python 2.7
80 1 みぞ @mizo0203
81 17 みぞ @mizo0203
* Google App Engine for Python の無料枠では Python 2.7 しか動かせない
82
    * 
83
* ただし、 Python 3 系に Porting できる実装で行う
84
85
## 設計資料
86
87
[[Design_Documents|設計資料]]
88
89 1 みぞ @mizo0203
## Google App Engine for Java を利用する開発
90 17 みぞ @mizo0203
91
サーバーはJSONを処理できれば、何でも使用できる
92 1 みぞ @mizo0203
93 9 みぞ @mizo0203
* IntelliJ IDEA Community Edition で環境構築
94
    * https://cloud.google.com/tools/intellij/docs/quickstart-IDEA
95 10 みぞ @mizo0203
    * https://cloud.google.com/tools/intellij/docs/create-standard
96 13 みぞ @mizo0203
97
## 利用 OSS ライブラリ
98
99
| 名前 | License | URL |
100
|:----------:|:-----------:|:------------:|
101
| Apache Commons IO | Apache 2.0 | https://commons.apache.org/proper/commons-io/ |
102
103
### 利用目的
104
105
* Apache Commons IO
106
    * IOUtils: InputStream/OutputStream と String の相互変換