-
-
Notifications
You must be signed in to change notification settings - Fork 6.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adjust internal documentation according to #7812
- Loading branch information
Showing
8 changed files
with
146 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
Yii Developer Documentation | ||
=========================== | ||
|
||
This directory contains documentation about Yii Framework development and release process. | ||
|
||
Contributor Guidelines | ||
---------------------- | ||
|
||
- [How to Report an Issue](report-an-issue.md) | ||
- [Getting started](getting-started.md) | ||
- [Git workflow for Yii 2 contributors](git-workflow.md) - a step by step guide on how to set up your dev environment and start contributing to Yii. | ||
- [Yii2 Core Framework Code Style](core-code-style.md) | ||
- [Yii2 View Code Style](view-code-style.md) | ||
|
||
|
||
Dokumentation | ||
------------- | ||
|
||
- [Translation Status](translation-status.md) - which documents are ready for translation. | ||
- [Translation teams](translation-teams.md) | ||
- [Translation workflow](translation-workflow.md) | ||
|
||
|
||
Framework Development | ||
--------------------- | ||
|
||
- [Pull request quality assurance](pull-request-qa.md) | ||
- [Automated Tasks](automation.md), like code style fixes, automatic documentation and file generation. | ||
- [Design Decisions](design-decisions.md) - a FAQ-like list of statements about commonly debated things. | ||
|
||
Versioning and Release | ||
---------------------- | ||
|
||
- [Project Organization](project-organization.md) | ||
- [Yii Versioning](versions.md) | ||
|
||
|
||
Misc | ||
---- | ||
|
||
### Exception Hierarchy | ||
|
||
![Yii Framework Exception Hierarchy](exception_hierarchy.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
Project Organization | ||
==================== | ||
|
||
This document describes the organization of the Yii2 development repositories. | ||
|
||
1. Individual Core extensions and application templates are maintained in | ||
separate *independent* GitHub projects under the [yiisoft](https://github.com/yiisoft) Github organization. | ||
|
||
Extension repository names are prefixed with `yii2-`, e.g. `yii2-gii` for the `gii` extension. | ||
The composer package name is equal to the Github repository path, e.g. `yiisoft/yii2-gii`. | ||
|
||
Application template repository names are prefixed with `yii2-app-`, e.g. `yii2-app-basic` for the `basic` application template. | ||
The composer package name is equal to the Github repository path, e.g. `yiisoft/yii2-app-basic`. | ||
|
||
Each extension/app project will | ||
|
||
* maintain its tutorial doc in its "docs" folder. The API doc will be generated on-the-fly when the extension/app is being released. | ||
* maintain its own test code in its "tests" folder. | ||
* maintain its own message translations and all other relevant meta code. | ||
* track issues via the corresponding GitHub project. | ||
|
||
Extension repositories will be released independently as needed, Application templates will be released together with the framework. | ||
See [versioning policy](versions.md) for more details. | ||
|
||
2. The `yiisoft/yii2` project is the main repository for developing Yii2 framework. | ||
This repository provides the composer package [yiisoft/yii2-dev](https://packagist.org/packages/yiisoft/yii2-dev). | ||
It contains the core framework code, framework unit tests, the definitive guide, and a set of build tools for framework development and release. | ||
|
||
Core framework bugs and feature requests are tracked in the issue tracker of this Github project. | ||
|
||
3. The repository `yiisoft/yii2-framework` is a read-only git subsplit of the `framework` directory of the dev project repository and | ||
provides the composer package [yiisoft/yii2](https://packagist.org/packages/yiisoft/yii2) which is the official package to be | ||
used when installing the framework. | ||
|
||
4. For development the apps and extensions can be included in the dev project structure using the | ||
[build dev/app](git-workflow.md#prepare-the-test-environment)-Command. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters