GitHub、VScodeでのアプリ作成時に初期生成しておくと便利なファイル

概要

GitHubとVSCodeを利用したPJ新規立ち上げ時に初期構成しておいた方が良いものを列挙する。
1.GitHubのPRテンプレート作成
2.開発環境設定
3.コーディングルールの規定
4.git管理対象外の設定

GitHubのPRテンプレート作成

記載方法を統一しないとレビュアーとレビューイ双方の認識がずれるのでテンプレートを用いる。

1. PJのルートフォルダに.githubフォルダを作成
2. 作成したフォルダ内でPULL_REQUEST_TEMPLATE.mdを作成

開発環境設定

ローカル環境、開発環境、検証環境、本番環境と分けて開発することが多いが、環境に応じて環境変数を切り替える設定をしておく。

1. ルートフォルダに.envファイルを作成してデフォルト設定を定義
2. .env.devや.env.stg等を作成して、それぞれに環境変数を記載してデフォルトを上書きする

コーディングルールの規定

JSなどの細かい言語ごとにおける規定はlintで行うので、タブやインデント等の記載方法をエディター設定で統一する。lintについては言語、PJ方針とライブラリによるので割愛。フレームワークで初期設定されることが多い。

1. ルートフォルダに.editorconfigファイルの作成
2. 設定を記述。一例を記載

indent_style = space 　　　　　　　　　　　　　　　　　　　　　　　　## インデントをタブあるいは空白で行うかの設定
indent_size = 2      　　　　　　　　　　　　　　　　　　　　　　　　## 1インデントあたりの個数。例では1インデントあたり2個の空白としている。
end_of_line = lf     　　　　　　　　　　　　　　　　　　　　　　　　## 改行コードの種類
trim_trailing_whitespace = true  ## 行末の空白削除を自動で行うか
insert_final_newline = true　　　　　　　　　　　　## 最終行に空行を自動で挿入するか
max_line_length = 80            ## １行当たりの文字数制限

git管理対象外の設定

自動生成すると作成されていることが多いが念のため記載。

1. ルートフォルダに.gitignoreを作成
2. 管理対象外とするフォルダやファイルを記載

/node_modules
*.pem