baserCMS Documentation

Githubでこのページを編集

Home / 5 / ucmitz 開発への貢献方法

ucmitz 開発への貢献方法

「ucmitz」は、baserCMSをCakePHP4に対応するプロジェクトの開発コードネームです。コアデベロッパーの gondoh が命名しました。

開発に貢献頂ける場合は、dev ブランチを利用してください。

 

開発方針とロードマップの確認

開発に貢献する前に、開発方針とロードマップを必ず確認しましょう。ucmitz は、メジャーバージョンを3回刻んだ後、baserCMS5としてリリースされます。
なお、ucmitz は、PHP7.2以降でのみ動作します。詳細についてはシステム要件を確認します。

開発の準備

次のドキュメントを参考に、ucmitz がローカル環境で動作するように準備します。Docker on Vagrant の環境を提供しています。
なお、ucmitz は、主に BaserAppBaserCoreBcAdminThird の3つコアパッケージを中心に、ブログやメールフォームなどコアプラグインで構成されます。
詳細については、パッケージ構成を参照してください。

 

開発にとりかかる

開発の手順と移行上のルール

実際の開発については、開発の手順に従って開発します。
なお、baserCMS4のコードを移行していくことが ucmitzの開発になるのですが、様々なルールがありますので必ず確認してください。すごく重要なことです。

  

開発上の注意点

baserCMS4で利用しているCakePHP2系からCakePHP4系に移行するにあたり、様々な変更点や注意点があります。

 

テーマの開発

ucmitz の管理画面テーマやフロントの開発では、sass や Webpack を利用します。詳細については次を確認してください。

 

ユニットテスト

ucmitz の開発では、ユニットテストのカバレッジ100%を目指します。ユニットメソッドの作成方法と実行方法については次を確認してください。

 

Issueの管理

 

全体的な変更点と既知の問題点

開発における全体的な変更点や既知の問題点については次を確認してください。

 

開発の進捗管理と新しい課題や機能の定義

開発の進捗管理については、機能要件一覧と、Issue、そして、各ファイルや各メソッドのコメントにおけるアノテーションによって管理しています。コード移行時のマーキング を参考に必ずマーキングをお願いします。

また、実装における新たな課題(タスクやバグなど)を見つけた場合は、Issue にマイルストーンを設定した上で登録します。

新しく機能を定義したい場合は、機能要件一覧に存在するか確認し、なければ Issue を作成して話し合い、承認されれば機能要件一覧に追加します。

 

ドキュメントの追加・更新

開発ドキュメントは、GitHub.io を利用いています。
開発中に発生した開発に必要なドキュメントを追加・更新する場合は、ドキュメント作成ガイドライン をお読みください。

新しいドキュメントを作成した場合は、このファイル、もしくはこのファイルから辿れるファイルに必ずリンクを追加してください。全てのドキュメントはこのファイルから辿れるものとします。

できるだけ情報を拡充させて開発を楽にしてきましょう。

 

プロジェクトで ucmitz を利用する

ucmitz は、現在、CMSとしての機能はありませんが、Webアプリケーション開発プラットフォームとして利用でき、ログイン認証付きのリッチな管理画面を簡単に作成することができます。

自身のプロジェクトで ucmitz を利用する場合は、composer で簡単にインストールできますので、詳細については次のドキュメントを参照してください。