開発ルール

開発ルールとは?

効率よくチーム開発するための、自分なりの開発ルールです。
誰かに強いることはありませんが、個人的なメモとして。

共通開発ルール

ファイル記述

  1. タブは使用せずスペースを利用する。
  2. ファイルのインデントは常に2つ

stylesheets

  1. クラス名は_ではなく-を使う。
  2. 基本的にscssをコンパイルして使う。

Git運用

イシュー作成(issue)

  1. 「プロジェク名::タイトル」でissueのタイトルを定義する。
  2. asigneeには作業者を指名する。

マージリクエスト(Merge Request)

  1. タイトルは対応するissueと同じにする。
  2. closes #イシュー番号を本文に書くことで自動でissueもcloseさせる。
  3. asigneeはレビューする人を指定。
  4. reviewerは指定しなくても良い。

WordPress

固定ページ(page.php)

  1. 固定ページのテンプレートは作らない。
  2. 固定ページのレイアウトを分ける際はページスラッグに応じて条件分岐する。
  3. 固定ページのコーディングは基本shortcodeのみで行う。

記事ページ(single.php)

  1. 記事ページのテンプレートは作らない。
  2. 記事ページのレイアウトを分ける際はページスラッグに応じて条件分岐する。

ディレクトリ構成

  1. ファイル管理は使い慣れた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

  1. tunstions.phpには処理を書かない
  2. functions.phpでは分割したfunctions以下のファイルを読み込む

アセット管理

  1. stylesheetはbootstrapベースで行う
  2. stylesheetsはscssで行う
  3. scssでstyle.cssとして書き出してそれを読み込む