Extension Guide

Naming

See Naming.
See example extension: yii2-hi3a-authclient.

Determine for yourself:

• Package Type: yii2 extension, hisite/hipanel plugin, site/api
• Package Name
• Package Title
• Namespace

README

Be minimal: title, shortest possible description and link to Wiki.
Put all you want to say to wiki. DRY.

LICENSE

Copy. Only thing to change is the first line. Variants:

• yii2 extension: This Yii 2 extension is free software.
• hipanel plugin: The HiPanel and its modules are free software.
• other plugin: The $project, HiPanel and its modules are free software.

.gitignore

Usually just copy.

composer.json

Thoroughly look through example. All the fields must be filled according to example.

Folders and files

Think of staying small - without subfolders.
Edit your files. Don''t forget copyright header in EVERY file:

/**
 * @link    http://hiqdev.com/PACKAGE-NAME
 * @license http://hiqdev.com/PACKAGE-NAME/license
 * @copyright Copyright (c) 2014-2015 HiQDev
 */

Commit your files to git:

git init
git add .
git commit -am inited

GitHub

Be sure to put name and title exactly as you determined.

git add .
git commit -am inited
git remote add origin [email protected]:hiqdev/PACKAGE-NAME.git
git push -u origin master

Write documentation to Wiki. For the moment we are using GitHub Wiki. Don''t forget to mention that the project is the part of HiPanel or something.

Packagist

Add and setup hook to autoupdate.

HiQDev site

Url on the site going to be: https://hiqdev.com/PACKAGE-NAME