プロジェクト

全般

プロフィール

Wiki » 履歴 » バージョン 17

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

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