README

#KretaSimpleApiDocBundle

Bundle that generates Api documentation on top of NelmioApiDocBundle.

##Tests This bundle is completely tested by PHPSpec, SpecBDD framework for PHP.

Because you want to contribute or simply because you want to throw the tests, you have to type the following command in your terminal.

$ vendor/bin/phpspec run -fpretty

##Contributing This library follows PHP coding standards, so pull requests need to execute the Fabien Potencier's PHP-CS-Fixer and Marc Morera's PHP-Formatter. Furthermore, if the PR creates some not-PHP file remember that you have to put the license header manually. In order to simplify we provide a Composer script that wraps all the commands related with this process.

$ composer run-script cs

There is also a policy for contributing to this project. Pull requests must be explained step by step to make the review process easy in order to accept and merge them. New methods or code improvements must come paired with PHPSpec tests.

If you would like to contribute it is a good point to follow Symfony contribution standards, so please read the Contributing Code in the project documentation. If you are submitting a pull request, please follow the guidelines in the Submitting a Patch section and use the Pull Request Template.

If you have any doubt or maybe you want to share some opinion, you can use our Gitter chat.

##To do

Unit tests of ValidationParser class
Unit tests of ApiDocExtractor class

##Credits Kreta simple api doc bundle is created by:

@benatespina - benatespina@gmail.com
@gorkalaucirica - gorka.lauzirika@gmail.com

##Licensing Options

kreta / simple-api-doc-bundle

Maintainers

Details

README