Nobuo Kihara
8 years ago
15 changed files with 286 additions and 31 deletions
@ -0,0 +1,43 @@
|
||||
Yii 開発者ドキュメント |
||||
====================== |
||||
|
||||
このディレクトリは、Yii フレームワークの開発とリリースプロセスに関するドキュメントを含んでいます。 |
||||
|
||||
寄稿者のためのガイドライン |
||||
-------------------------- |
||||
|
||||
- [課題を報告する仕方](report-an-issue.md) |
||||
- [始めよう](getting-started.md) |
||||
- [Yii 2 寄稿者のための Git ワークフロー](git-workflow.md) - 開発環境をセットアップして Yii に対する寄稿を始めるためのステップバイステップのガイド。 |
||||
- [Yii2 コアフレームワークコードスタイル](core-code-style.md) |
||||
- [Yii2 ビューコードスタイル](view-code-style.md) |
||||
|
||||
|
||||
ドキュメント |
||||
------------ |
||||
|
||||
- [翻訳ステータス](translation-status.md) - どのドキュメントが翻訳できる状態か。 |
||||
- [翻訳チーム](translation-teams.md) |
||||
- [翻訳ワークフロー](translation-workflow.md) |
||||
|
||||
|
||||
フレームワーク開発 |
||||
------------------ |
||||
|
||||
- [プルリクエストの品質保証](pull-request-qa.md) |
||||
- [自動化されるタスク](automation.md) コードスタイルの修正、ドキュメントやファイルの自動生成など。 |
||||
- [設計上の決定](design-decisions.md) - よく議論される事柄についての FAQ 形式の声明リスト。 |
||||
|
||||
バージョニングとリリース |
||||
------------------------ |
||||
|
||||
- [プロジェクトの編成](project-organization.md) |
||||
- [Yii のバージョニング](versions.md) |
||||
- [新しいバージョンのリリース](release.md) |
||||
|
||||
その他 |
||||
------ |
||||
|
||||
### 例外の階層 |
||||
|
||||
![Yii フレームワークの例外階層](exception_hierarchy.png) |
After Width: | Height: | Size: 63 KiB |
Binary file not shown.
@ -0,0 +1,33 @@
|
||||
プロジェクトの編成 |
||||
================== |
||||
|
||||
このドキュメントは Yii2 開発レポジトリの編成を説明するものです。 |
||||
|
||||
1. 個々のコアエクステンションとアプリケーションテンプレートは、[yiisoft](https://github.com/yiisoft) Github オーガニゼーションの下の *独立した* 別の Github プロジェクトとして保守されます。 |
||||
|
||||
エクステンションのプロジェクト名は、先頭に `yii2-` を付けます。例えば、`gii` エクステンションは `yii2-gii` です。 |
||||
Composer のパッケージ名は Github レポジトリ名と同じで、例えば `yiisoft/yii2-gii` です。 |
||||
|
||||
アプリケーションテンプレートのプロジェクト名は、先頭に `yii2-app-` を付けます。例えば、`basic` アプリケーションテンプレートは `yii2-app-basici` です。 |
||||
Composer のパッケージ名は Github レポジトリ名と同じで、例えば `yiisoft/yii2-app-basic` です。 |
||||
|
||||
各々のエクステンション/アプリケーションのプロジェクトは、 |
||||
|
||||
* "docs" フォルダにおいてそのチュートリアルドキュメントを保守します。API ドキュメントは、エクステンション/アプリケーションがリリースされるときにその場で生成されます。 |
||||
* "tests" フォルダにおいてそれ自身のテストコードを保守します。 |
||||
* それ自身のメッセージ翻訳やその他全ての関係するメタコードを保守します。 |
||||
* 対応する Github プロジェクトによって、課題 (issue) を追跡します。 |
||||
|
||||
エクステンションのレポジトリは、必要に応じて、個別にリリースされます。アプリケーションテンプレートはフレームワークとともにリリースされます。 |
||||
詳細は [バージョンポリシー](versions.md) を参照して下さい。 |
||||
|
||||
2. `yiisoft/yii2` プロジェクトが、Yii2 フレームワーク開発のためのメインレポジトリです。 |
||||
このレポジトリは Composer パッケージ [yiisoft/yii2-dev](https://packagist.org/packages/yiisoft/yii2-dev) を提供します。 |
||||
これは、コアフレームワークコード、フレームワークの単体テスト、決定版ガイド、そして、フレームワーク開発とリリースのための一組のビルドツールを含んでいます。 |
||||
|
||||
コアフレームワークのバグと機能要望は、この Github プロジェクトのイッシュートラッカーによって追跡されます。 |
||||
|
||||
3. `yiisoft/yii2-framework` レポジトリは、開発プロジェクトレポジトリの `framework` ディレクトリのリードオンリーな git subsplit です。 |
||||
このレポジトリが、フレームワークのインストールに使用される Composer 公式パッケージである [yiisoft/yii2](https://packagist.org/packages/yiisoft/yii2) を提供します。 |
||||
|
||||
4. 開発するときには、[build dev/app](git-workflow.md#prepare-the-test-environment) コマンドを使って、アプリケーションとエクステンションを開発プロジェクトの構成に含めることが出来ます。 |
@ -1,10 +1,10 @@
|
||||
プルリクエストの品質保証 |
||||
======================== |
||||
|
||||
PR をマージするか否かをチェックするときには、特に以下の基準が考慮されるべきです。 |
||||
PR をマージできるか否かをチェックするときには、特に以下の基準が考慮されるべきです。 |
||||
|
||||
- PR にリンクされている課題(イッシュー)が存在するか、または、PR がどのようなことを修正ないし追加しようとしているのかに関する十分な説明があること。 |
||||
- 単体テスト。必須ではありませんが、非常に高く評価されます。PR によって修正されたコードが無ければ失敗する、というテストであること。 |
||||
- CHANGELOG のエントリがあること。エントリは次のリリースのセクションに、イッシューのタイプと番号の順に書き入れます。 |
||||
- 単体テスト。必須ではありませんが、大いに歓迎されます。PR によって修正されるコードが無ければ失敗する、というテストであること。 |
||||
- CHANGELOG のエントリがあること。エントリは次のリリースのセクションに、課題のタイプと番号の順に書き入れます。 |
||||
担当した者のニックネームがあること。 |
||||
- [コードスタイル](core-code-style.md) および [ビューコードスタイル](view-code-style.md) が OK であること。これらは、マージされる際に、マージする者の判断に従って修正される場合があります。 |
||||
|
@ -0,0 +1,69 @@
|
||||
新しいバージョンのリリース |
||||
========================== |
||||
|
||||
フレームワークのリリースを作成するのに必要とされる手順のリストは、時とともに長くなり、手作業で管理するのが困難になっています。 |
||||
そのため、どの手順も忘れられることが無いように、コマンドラインツールを作成しました。 |
||||
|
||||
リリースの手順の概要 |
||||
-------------------- |
||||
|
||||
- ... |
||||
|
||||
リリースコマンド |
||||
---------------- |
||||
|
||||
リリースの手順は、フレームワークの開発レポジトリに含まれている [release コンソールコマンド](../../build/controllers/ReleaseController.php) によって自動化されています。 |
||||
|
||||
リリースコマンドは、フレームワークの `build` ディレクトリに含まれている Yii アプリケーションを使って呼び出すことが出来ます。 |
||||
|
||||
./build/build help release # このコマンドをフレームワークのレポジトリのルートで実行します |
||||
|
||||
> Info: コマンドを `--dryRun` オプションを付けて実行すると、どのようになるかを見ることが出来ます。 |
||||
> このオプションを使うと、変更は何もなされず、どんなコミットやタグも生成されたり、プッシュされたりしません。 |
||||
|
||||
### 必要条件 |
||||
|
||||
リリースコマンドは、[Git ワークフローのドキュメント](git-workflow.md#extensions) で紹介されている開発環境に依存しています。 |
||||
すなわち、アプリケーションテンプレートは `/apps/` の下に配置されていなければならず、 |
||||
エクステンションは `/extensions/` の下に配置されていなければなりません。 |
||||
`dev/app` コマンドを使うと、この構成がデフォルトで作成されます。 |
||||
|
||||
### バージョンの概要 |
||||
|
||||
フレームワークとエクステンションのバージョンについて概要を把握したいときは、以下を実行することが出来ます。 |
||||
|
||||
./build/build release/info |
||||
|
||||
全てのレポジトリのタグを取得するために `--update` を指定して実行し、最新の情報を取得することも出来ます。 |
||||
|
||||
### リリースを作成する |
||||
|
||||
フレームワークのリリースの作成では、下記のコマンドの実行します (アプリケーションは常にフレームワークと一緒にリリースされます)。 |
||||
|
||||
./build release framework |
||||
./build release app-basic |
||||
./build release app-advanced |
||||
|
||||
エクステンションのリリースの作成では、実行するコマンドは一つだけです (例えば、redis なら) |
||||
|
||||
./build release redis |
||||
|
||||
リリースコマンドは、デフォルトでは、現在チェックアウトされているブランチを元に新しいマイナーバージョンをリリースします。 |
||||
デフォルトと異なるバージョンをリリースするためには、`--version` オプションを使ってバージョンを指定する必要があります。例えば、 |
||||
`--version=2.1.0`, or `--version=2.1.0-beta`. |
||||
|
||||
|
||||
#### 新しいメジャーバージョン、例えば 2.1.0 をリリースする |
||||
|
||||
新しいメジャーバージョンのリリースは、[バージョン規約](versions.md) で説明されているように、ブランチの変更を伴います。 |
||||
以下は、`master` から派生した `2.1` ブランチ上で開発されている `2.1.0` バージョンをリリースする例を示すものです。 |
||||
リリース前においては `master` は `2.0.x` の諸バージョンを含んでいます。 |
||||
|
||||
- `master` から新しいブランチ `2.0` を作成する |
||||
- composer.json がこのブランチに対するブランチエイリアスを含まないようにする |
||||
- 必要な変更を `master` から `2.1` にマージする |
||||
- `master` が `2.1` の最新のコミットを指すようにする |
||||
- composer.json のマスターに対するブランチエイリアスを `2.1.x-dev` とする |
||||
- `2.1` ブランチを削除する |
||||
|
||||
`master` をチェックアウトし、`--version=2.1.0` オプションを付けて、リリースコマンドを実行する。 |
Binary file not shown.
@ -0,0 +1,4 @@
|
||||
翻訳ステータス |
||||
============== |
||||
|
||||
すべてのドキュメントが翻訳可能な状態です。 |
@ -0,0 +1,65 @@
|
||||
翻訳チーム |
||||
========== |
||||
|
||||
ブラジルのポルトガル語 |
||||
---------------------- |
||||
|
||||
- **Davidson Alencar, [@davidsonalencar](https://github.com/davidsonalencar), davidson.t.i@gmail.com** |
||||
- [@wbraganca](https://github.com/wbraganca) |
||||
- Alan Michel Willms Quinot, [@alanwillms](https://github.com/alanwillms), dyulax@gmail.com |
||||
|
||||
中国語 |
||||
------ |
||||
|
||||
- **Paris Qian Sen 东方孤思子,[@qiansen1386](https://github.com/qiansen1386),qiansen1386@gmail.com** |
||||
- [@AbrahamGreyson 刘阳](https://github.com/AbrahamGreyson) |
||||
- [@fmalee](https://github.com/fmalee) |
||||
- [@funson86 花生](https://github.com/funson86) |
||||
- [@ivantree 长兴苗木](https://github.com/ivantree) |
||||
- [@netyum 未来](https://github.com/netyum) |
||||
- [@riverlet 小河](https://github.com/riverlet) |
||||
- [@yiichina 巡洋舰](https://github.com/yiichina) |
||||
|
||||
フィンランド語 |
||||
-------------- |
||||
|
||||
- Jani Mikkonen, [@janisto](https://github.com/janisto), janisto@php.net |
||||
|
||||
ドイツ語 |
||||
-------- |
||||
|
||||
- Carsten Brandt, [@cebe](https://github.com/cebe), mail@cebe.cc |
||||
|
||||
イタリア語 |
||||
---------- |
||||
|
||||
- Lorenzo Milesi, [@maxxer](https://github.com/maxxer), maxxer@yetopen.it |
||||
|
||||
日本語 |
||||
------ |
||||
|
||||
- Nobuo Kihara 木原伸夫, [@softark](https://github.com/softark), softark@gmail.com |
||||
- Tomoki Morita, [@jamband](https://github.com/jamband), tmsongbooks215@gmail.com |
||||
- Hisateru Tanaka, [@tanakahisateru](https://github.com/tanakahisateru), tanakahisateru@gmail.com |
||||
|
||||
ロシア語 |
||||
-------- |
||||
|
||||
- **Alexander Makarov, [@samdark](https://github.com/samdark), sam@rmcreative.ru** |
||||
- [@MUTOgen](https://github.com/MUTOgen) |
||||
- [@prozacUa](https://github.com/prozacUa) |
||||
|
||||
スペイン語 |
||||
---------- |
||||
|
||||
- Luciano Baraglia, [@lucianobaraglia](https://github.com/lucianobaraglia) |
||||
- Marco Da Silva, [@markmarco16](https://github.com/markmarco16), markmarco16@gmail.com |
||||
- Daniel Gómez Pan [@pana1990](https://github.com/pana1990), pana_1990@hotmail.com |
||||
|
||||
ウクライナ語 |
||||
------------ |
||||
|
||||
- **Alexandr Bordun [@borales](https://github.com/Borales), admin@yiiframework.com.ua** |
||||
- Roman Bahatyi [@RichWeber](https://github.com/RichWeber), rbagatyi@gmail.com |
||||
- Igor Zozulinskyi [@3y3ik](https://github.com/3y3ik) |
||||
- Vadym Chenin [@vchenin](https://github.com/vchenin), vchenin@meta.ua |
After Width: | Height: | Size: 813 KiB |
Loading…
Reference in new issue