Back to Yii2

Project Organization

docs/internals-ru/project-organization.md

2.0.542.8 KB
Original Source

Организация проекта

Этот документ описывает организацию репозиториев для разработки Yii 2.

  1. Отдельные core-расширения и шаблоны приложений хранятся в независимых GitHub-проектах в организации yiisoft.

    Имена репозиториев расширений начинаются с yii2-, например yii2-gii для расширения gii. Имя пакета composer совпадает с путём на GitHub, например yiisoft/yii2-gii.

    Имена репозиториев шаблонов приложений начинаются с yii2-app-, например yii2-app-basic для шаблона basic. Имя пакета composer совпадает с путём на GitHub, например yiisoft/yii2-app-basic.

    Каждый проект расширения/приложения:

    • хранит документацию в папке "docs". API-документация генерируется автоматически при релизе.
    • хранит тесты в папке "tests".
    • хранит переводы и другие мета-файлы.
    • ведёт учёт issues через свой GitHub-проект.

    Расширения релизятся независимо по мере необходимости. Шаблоны приложений релизятся вместе с фреймворком. Подробности в политике версионирования.

  2. Проект yiisoft/yii2 - основной репозиторий для разработки Yii 2. Предоставляет composer-пакет yiisoft/yii2-dev. Содержит код ядра фреймворка, модульные тесты, полное руководство и инструменты для разработки и релиза.

    Баги и запросы на функции ядра отслеживаются в issue tracker этого проекта.

  3. Репозиторий yiisoft/yii2-framework - read-only git subsplit директории framework из dev-репозитория. Предоставляет composer-пакет yiisoft/yii2, который и является официальным пакетом для установки фреймворка.

  4. Для разработки приложения и расширения можно включить в структуру dev-проекта командой build dev/app.