開発フロー - shinkasystems/kintaikanri GitHub Wiki

開発時におけるリポジトリと、Eclipse プロジェクトの取り扱いを説明します。 開発の大筋を説明するドキュメントです。

プロジェクトの作成

Fork

shinkasystems / kintaikanri を自分のアカウントへ Fork する。

フォークすると自分のアカウントに kintaikanri のリポジトリが表示される。

Clone

自分のアカウントに作成されたリポジトリから、 master ブランチを、ローカルPCに Clone する。

適当な場所にローカルリポジトリとなるディレクトリを作成する。

GitHub の自アカウントの kintaikanri リポジトリ画面から URL を取得する。

取得した URL をクローン画面の URL の欄に入力する。 ディレクトリの欄には作成したローカルリポジトリのディレクトリを指定する。

Create Branch

master ブランチから新しいブランチを作成する。

本手順書では便宜上 develop ブランチとする。 開発者同士でブランチ名が被るとわかりづらいので、 修正内容の要点をブランチ名にするとよい。

Eclipseプロジェクトへインポート

ローカルPCにクローンしたローカルリポジトリを eclipse からインポートする。

Gradle プロジェクトを選択する。

ルートフォルダーにクローンしたローカルリポジトリを指定し、 モデルのビルドを行う。 ビルドが成功するとプロジェクトに Kintai が表示されるので、 チェックしインポートを完了させる。

プロジェクトの設定

Kintai プロジェクトのプロパティを開く。

「Java コンパイラー > 注釈処理」を開き、

• 「プロジェクト固有の設定を可能にする」をチェック
• 「注釈処理を使用可能にする」をチェック
• 「エディターでの処理を使用可能にする」をチェック
• 生成されるソース・ディレクトリに .apt_generated を指定

「Java コンパイラー > 注釈処理 > ファクトリー・パス」を開き、

• 「プロジェクト固有の設定を可能にする」をチェック
• 「外部 Jar 追加」ボタンをクリックし、
• 「注釈プロセッサーを含むプラグインおよび JAR」に doma-2.1.0.jar を指定

再ビルドを促すダイアログが表示されたら、 ビルドを行う旨で「はい」ボタンをクリックする。

この時点でエラーが出ていたら別途対応する。 エラーの原因に見当がつかなければ、有識者に問い合わせること。

動作確認

Start クラスを右クリックし、「Java アプリケーションとして実行」をクリックする。

ブラウザから http://localhost:8080/ にアクセスする。

ログイン画面に

• ユーザー名 admin
• パスワード admin を入力し、ログインボタンをクリックする。

一覧画面が表示されればOK

開発内容のプルリクエスト

Commit

修正を行ったらコミットする。

コミットのタイミングは自分の好きなタイミングでよいが、 以下の点を意識すると良いだろう。

• コンパイル可能であること
• コミットの粒度が論理的に一意であること

なお、master リポジトリにはコミットしないこと。 しても良いがプルリクエストは受け付けない。

Push

自分のアカウントのリモートリポジトリに push する。

ローカルは、開発を行ったブランチ、リモートは origin を選択する。

自由なタイミングで push してよいが、 push した時点でインターネット上に公開されることを意識してもらいたい。

Pull Request

一通りの修正が完了したらプルリクエストする。

プルリクエストは以下の条件を満たす必要がある。

• Create branch で作成したブランチであること
• 単体試験が完了していること（ソースコードレビューと前後するかも）

ソースコードレビュー

プルリクエストされた内容は、ソースコードレビューの対象となる。 ソースコードレビューはレビュアーとレビュイーの双方が納得するまで繰り返す。

Fork 元との同期

upstream の登録（初回だけ）

ローカルリポジトリの設定を開く。

Fork 元のリモートリポジトリを upstream という名前で登録する。

upstream から pull する

リモートの upstream からローカルの master へ Pull する。

• リモートに upstream を選択
• リモートブランチに 'master' を選択

開発用ブランチへマージする

ローカルの master から ローカルの develop （開発用ブランチ）へマージする。

ブランチに master を選択する。

マージからリリースまで（補足）

master ブランチへマージ（コミッターの作業）

ソースコードレビューが完了したリソースは、 kintaikanri の master ブランチへマージされる。 マージされたプルリクエストは総合試験対象となる。

総合試験

仮想環境にて総合試験を行う。 試験が完了しリリースの準備が整ったら、タグとリリースを作成する。

運用環境へリリース

検収後、運用環境へリリースする。