Development notes
Phing targets
$ phing setup
: Prepare project for development.$ phing qa
: Run quality tests, use this before every commit.
Documentation
Documentation is built when a release
is created.
To install mkdocs locally type:
sudo -H pip install mkdocs
Using Phing behind a proxy
If you are developing behind a proxy, you have to set the environment
variable http_proxy
. This variable already is imported in build.xml
, so you
have nothing to do.
Creating new convention
- Create new Gluer class
- Create new split car
- Update
\Jawira\CaseConverter\Convert::analyse
if needed - Register into
\Jawira\CaseConverter\Convert::handleSplitterMethod
- Register into
\Jawira\CaseConverter\Convert::handleGluerMethod
- Update docblock
\Jawira\CaseConverter\Convert
to register new methods. - Update documentation