This repository is private.
All pages are served over SSL and all pushing and pulling is done over SSH.
No one may fork, clone, or view it unless they are added as a member.
Every repository with this icon (
) is private.
Every repository with this icon (
This repository is public.
Anyone may fork, clone, or view it.
Every repository with this icon (
) is public.
Every repository with this icon (
Module Guidelines
General
- While it is not necessary, please provide as much documentation for your module as possible, in the form of NaturalDocs.
- Do not store any information in the module’s directory unless it is absolutely necessary to do so.
- Use
/includes/cachesfor caches. - Use
Config::current()->uploads_pathfor uploads. - Use “
Config::current()->set()”:http://chyrp.net/docs/config-php.html#Config.set (on install) and “Config::current()->remove()”:http://chyrp.net/docs/config-php.html#Config.remove (on uninstall) for storing configuration.
- Use
- Please try to keep the “conflicts” setting in the
info.yamlfile updated. - Whenever possible, use a
LEFT JOINto keep the load on the server down, especially for things that extend the Post model.
Models
If you plan on providing a Model with your module, there are a few guidelines to follow:
- If it’s one model, name it
model.Foo.php.- If it’s more than one, name them
/models/Foo.php
- If it’s more than one, name them
- Stick as close to the Model class as possible.
- When it makes sense, please provide appropriate has_many, belongs_to, and has_one relationships.







