From 5caac5b0a3be3e5685c2cbee00cf3a5b7d72e94b Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Tue, 10 Dec 2013 23:14:04 +0100 Subject: [PATCH] Moved extensions docs draft from wiki to main repository --- docs/guide/extensions.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/docs/guide/extensions.md b/docs/guide/extensions.md index 2fcea72..fd7c3cc 100644 --- a/docs/guide/extensions.md +++ b/docs/guide/extensions.md @@ -1,4 +1,46 @@ Extending Yii ============= -TDB \ No newline at end of file +Code style +---------- + +- Extension code style should be similar to [core framework code style](https://github.com/yiisoft/yii2/wiki/Core-framework-code-style). +- In case of using getter and setter for defining a property it's preferred to use method in extension code rather than property. +- TBD: namespace +- All classes, methods and properties should be documented using phpdoc. Note that you can use markdown and like to API +documents using `[[name()]]`. +- If you're displaying errors to developers do not translate these (i.e. do not use `\Yii::t()`). Errors should be + translated only if they're displayed to end users. + +Distribution +------------ + +- There should be a `readme.md` file clearly describing what extension does in English, its requirements, how to install + and use it. It should be written using markdown. If you want to provide translated readme, name it as `readme_ru.md` + where `ru` is your language code. +- TBD: composer.json + +Working with database +--------------------- + +- If extension creates or modifies database schema always use Yii migrations instead of SQL files or custom scripts. + +Assets +------ + +TBD + +Events +------ + +TBD + +i18n +---- + +TBD + +Testing your extension +---------------------- + +TBD \ No newline at end of file