開発ルール
開発ルールとは?
効率よくチーム開発するための、自分なりの開発ルールです。
誰かに強いることはありませんが、個人的なメモとして。
共通開発ルール
ファイル記述
- タブは使用せずスペースを利用する。
- ファイルのインデントは常に2つ
stylesheets
- クラス名は_ではなく-を使う。
- 基本的にscssをコンパイルして使う。
Git運用
イシュー作成(issue)
- 「プロジェク名::タイトル」でissueのタイトルを定義する。
- asigneeには作業者を指名する。
マージリクエスト(Merge Request)
- タイトルは対応するissueと同じにする。
- closes #イシュー番号を本文に書くことで自動でissueもcloseさせる。
- asigneeはレビューする人を指定。
- reviewerは指定しなくても良い。
WordPress
固定ページ(page.php)
- 固定ページのテンプレートは作らない。
- 固定ページのレイアウトを分ける際はページスラッグに応じて条件分岐する。
- 固定ページのコーディングは基本shortcodeのみで行う。
記事ページ(single.php)
- 記事ページのテンプレートは作らない。
- 記事ページのレイアウトを分ける際はページスラッグに応じて条件分岐する。
ディレクトリ構成
- ファイル管理は使い慣れたRailsのレイアウトに準ずる
/theme
/assets //静的アセットはここ
/images
/stlesheets
/bootstrap //bootstrapのコンパイル前のデータ
/bootstrap.php
/restyle.scss
/views //ページの表示に関するファイル
/shortcodes //管理画面から呼び出す用のファイル
/profile_index.php
/profile_show.php
/single
/page
/functios //functions.phpに書く内容は分割して管理
/thumbnail.php
/index.php
/home.php
/404.php
/page.php
/single.php
/style.css
/functions.php
functions.php
- tunstions.phpには処理を書かない
- functions.phpでは分割したfunctions以下のファイルを読み込む
アセット管理
- stylesheetはbootstrapベースで行う
- stylesheetsはscssで行う
- scssでstyle.cssとして書き出してそれを読み込む