# コーディング外注時の確認事項

本資料はWebコンテンツ制作におけるコーディング業務を外注する際に、外注を依頼する企業に向けての確認事項をまとめたものです。
開発プロセスなどについて事前に認識を揃えて、作業開始後のトラブルを防止することを目的としています。
お手数ですがご協力いただけると幸いです。

## Q1. バージョン管理について

弊社ではコンテンツのバージョン管理に**Git**、Gitのホスティングサービスに**AWS CodeCommit**を利用しています。
基本的にはコンテンツの二重管理防止や進捗の把握を目的として弊社のAWS CodeCommitに招待し、その中で作業を実施していただく予定ですが、対応可能でしょうか？

※ こちらから提供する作業用のユーザはIP制限を掛けさせていただきます

## Q2. 弊社関係者確認用環境のご提供について
弊社が管理しているサーバー環境は、以下の役割をもったもののみとなります。
- 本番環境（Production 略Prd）・・・世の中に公開するコンテンツを格納する環境
- ステージング環境（Stagin 略stg）・・・最終テスト用に用いる、限りなく本番環境に近い環境

いわゆる開発環境（developer 略dev）の用意はございません。
恐れ入りますが、弊社関係者レビュー用の環境は貴社にてご用意いただけますと幸いです。
希望要件は以下の通りです。
- https化
- Basic認証
※秘密保持、セキュリティの観点から関係者以外触れない状態としたいため
## Q3. 納品までの作業フローについて
作業開始から納品までの大まかな作業フローについてです。
こちらのフローで問題や不明点などがないか、また案件の特性に応じて必要なフローがないかなど精査のご協力をお願いします。

### STEP1：事前準備編

- コーディングから納品フェーズにおけるゴール・期待成果の認識合わせと合意形成を行う（主に本ドキュメントに記載している項目について確認）
- CodeCommitアカウント発行（弊社）とリポジトリのご共有と動作確認

開発における確認事項、不明点は概ねクリアになった段階で次のステップに移行します。

### STEP2：開発編

対象リポジトリをクローンして開発開始。
ブランチの運用に関しては、予め弊社で用意した作業用ブランチの中で作業を行っていただきます。
開発の必要に応じて作業用ブランチから更にブランチを作成・削除など、貴社内で運用いただくことは可能ですが、弊社提供のブランチ以外を操作するのはご遠慮ください。

弊社関係者がレビュー可能な状態になった段階で次ステップに移行します。

### STEP3：コンテンツレベルの確認編

主にデザインやレスポンシブ上の崩れがないか？といったコンテンツレベルの確認を実施するフェーズです。
1. Q2.でご提供いただいた関係者レビュー用環境で、弊社関係者レビューを行います。(※1)
2. 指摘・修正のサイクル（※2）を回していきます。
3. 関係者からの指摘が全て対応された段階で次ステップに移行します。（※3）

※1 弊社の回覧フローについては別途案件進行前にご相談ください。なお、Web課でのコーディングにおけるコンテンツチェック観点については以下が挙げられます。
https://chibineko.jp/t/hTqtKAYLeP-VS3gS7l5nXQ
他コンテンツオーナーである事業会社でも別の観点での確認が入るかと思いますので、適宜ご対応をお願いいたします。
※2 課題管理の方法は別途案件進行前にご相談ください。
※3 納期の関係でリリース後修正になる指摘が発生した場合は別途ご相談ください。

### STEP4：弊社ステージング環境での検証〜納品

この段階でコンテンツに関しての開発は完了している状態です。

masterブランチに対してのPullRequestをお願いします。
PullRequestを持って、弊社制作チームにてステージング環境にコンテンツをアップロード。
主に以下観点で検証を実施します。

- CDNやCMSを経由した本番同様のステージング環境下で、関係者レビュー用環境と同様にコンテンツが表示されること
- コーディング規約が遵守されているか？(Lintツールのチェックでエラーが発生しないこと)

表示崩れなどを見つけましたら、PullRequest上で指摘をお返しします。
修正後、再度PullRequestをお願い致します。

指摘が全て対応された段階でmasterブランチへのマージを行って納品完了と致しますが問題ないでしょうか？

## Q4. コーディング規約について

成果物のコーディング品質を保つ上で、弊社が用意したコーディング規約に沿って開発を行っていただきたいのですが、問題ないでしょうか？

規約の内容は以下の通りです。

| 基本ルール | **それ以外の細かいルール** |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| ・文字コードはUTF-8<br />・改行コードはLF<br />・インデントはスペース2つ | ・HTMLは予め用意された**htmlhint**の設定に従う<br />・JSは予め用意された**ESLint**の設定に従う<br />・CSSは予め用意された**Stylelint**の設定に従う<br />※ どうしてもチェック対応が難しいルールがあれば要相談 |

基本的には各Lintツールの推奨設定に従ったルールとなります。
※ 一部例外有り

上述した通り、納品時には成果物を対象にチェック処理を実施して警告・エラーが発生しないことを確認致します。

※設定ファイルはご共有するリポジトリにございます。
方針として問題ないようであれば詳細は後日ご相談でも問題ございません。

## ご承諾頂ける場合

上記内容についてご承諾いただける場合は、以下の情報を頂けますと幸いです。
対応が難しい場合は、理由と代替となる方法も合わせてご提案いただけると幸いです。

### 1)AWS CodeCommitのユーザ用のメールアドレス

AWS CodeCommitで作業を行っていただく際に、作業用のユーザを用意する必要があります。
お手数ですが、ユーザを発行するために作業を実施する方のメールアドレスを頂けますでしょうか。

### 2)AWS CodeCommitのIP制限用にアクセスを許可するIPアドレス

上述したユーザIDが事前に許可された環境外から作業が行えないように許可するIPアドレスを頂けますでしょうか。

### 3)開発マシンについて
MacとWinでAWS CodeCommitの設定方法が異なるため事前にご教示いただけますと幸いです。