Skip to content

Commit

Permalink
CS
Browse files Browse the repository at this point in the history
  • Loading branch information
benatespina committed Nov 2, 2015
1 parent 03d2f51 commit 6b38a33
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 18 deletions.
4 changes: 1 addition & 3 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
The MIT License (MIT)

Copyright (c) 2014, 2015 Kreta - by gorkalaucirica and benatespina
Copyright (c) 2014-2015 Gorka Laucirica & Beñat Espiña

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Kreta Simple Api Doc Bundle
#KretaSimpleApiDocBundle
>Bundle that generates Api documentation on top of **[NelmioApiDocBundle][0]**.
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/87e637fa-3e4e-47d1-8b27-fd5fe65e8def/mini.png)](https://insight.sensiolabs.com/projects/87e637fa-3e4e-47d1-8b27-fd5fe65e8def)
Expand All @@ -17,17 +17,12 @@ in your terminal.
$ vendor/bin/phpspec run -fpretty
```
##Contributing
This bundle follows PHP coding standards, so pull requests need to execute the Fabien Potencier's [PHP-CS-Fixer][5]
This library follows PHP coding standards, so pull requests need to execute the Fabien Potencier's [PHP-CS-Fixer][5]
and Marc Morera's [PHP-Formatter][6]. Furthermore, if the PR creates some not-PHP file remember that you have to put
the license header manually.
```
$ vendor/bin/php-cs-fixer fix
$ vendor/bin/php-cs-fixer fix --config-file .phpspec_cs
$ vendor/bin/php-formatter formatter:use:sort src/
$ vendor/bin/php-formatter formatter:use:sort spec/
$ vendor/bin/php-formatter formatter:header:fix src/
$ vendor/bin/php-formatter formatter:header:fix spec/
the license header manually. In order to simplify we provide a Composer script that wraps all the commands related with
this process.
```bash
$ 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
Expand All @@ -39,6 +34,7 @@ If you would like to contribute it is a good point to follow Symfony contributio
in the [Submitting a Patch][3] section and use the [Pull Request Template][4].

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

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kreta/kreta?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

##To do
Expand Down
27 changes: 23 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
{
"name": "kreta/simple-api-doc-bundle",
"description": "Kreta simple api doc bundle on top of NelmioApiDocBundle",
"keywords": ["api", "documentation", "kreta", "bundle"],
"keywords": [
"api",
"documentation",
"kreta",
"bundle"
],
"homepage": "http://kreta.io",
"license": "MIT",
"type": "symfony-bundle",
Expand All @@ -19,18 +24,32 @@
],
"require": {
"php": ">=5.4",

"nelmio/api-doc-bundle": "^2.8"
},
"require-dev": {
"fabpot/php-cs-fixer": "^1.10",
"mmoreram/php-formatter": "^1.0",
"phpspec/phpspec": "^2.3"
},
"scripts": {
"cs": [
"php-cs-fixer fix --config-file=.php_cs",
"php-cs-fixer fix --config-file=.phpspec_cs",
"php-formatter f:h:f src",
"php-formatter f:h:f spec",
"php-formatter f:u:s src",
"php-formatter f:u:s spec"
],
"test": "phpspec run"
},
"autoload": {
"psr-4": { "Kreta\\SimpleApiDocBundle\\": "src/" }
"psr-4": {
"Kreta\\SimpleApiDocBundle\\": "src/"
}
},
"autoload-dev": {
"psr-4": { "spec\\Kreta\\SimpleApiDocBundle\\": "spec/" }
"psr-4": {
"spec\\Kreta\\SimpleApiDocBundle\\": "spec/"
}
}
}

0 comments on commit 6b38a33

Please sign in to comment.