From 4990eb9152fd6ed94b231d46fd442840eff107a2 Mon Sep 17 00:00:00 2001
From: Guilhem N <egetick@gmail.com>
Date: Thu, 29 Dec 2016 13:35:36 +0100
Subject: [PATCH] Re-add contributing informations

---
 CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++
 README.md       | 41 +++++++++++++++++++++++++++++++++++++----
 2 files changed, 70 insertions(+), 4 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..3677a2c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+Contributing
+============
+
+First of all, **thank you** for contributing, **you are awesome**!
+
+Here are a few rules to follow in order to ease code reviews, and discussions before
+maintainers accept and merge your work.
+
+You MUST follow the [PSR-1](http://www.php-fig.org/psr/1/) and
+[PSR-2](http://www.php-fig.org/psr/2/). If you don't know about any of them, you
+should really read the recommendations. Can't wait? Use the [PHP-CS-Fixer
+tool](http://cs.sensiolabs.org/).
+
+You MUST run the test suite.
+
+You MUST write (or update) unit tests.
+
+You SHOULD write documentation.
+
+Please, write [commit messages that make
+sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
+and [rebase your branch](http://git-scm.com/book/en/Git-Branching-Rebasing)
+before submitting your Pull Request.
+
+One may ask you to [squash your
+commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)
+too. This is used to "clean" your Pull Request before merging it (we don't want
+commits such as `fix tests`, `fix 2`, `fix 3`, etc.).
+
+Also, while creating your Pull Request on GitHub, you MUST write a description
+which gives the context and/or explains why you are creating it.
+
+Thank you!
diff --git a/README.md b/README.md
index ef7a772..3d52a3b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
-# ApiDocBundle
+NelmioApiDocBundle
+==================
 
-[WIP] Generates Swagger docs from several sources
+[![Build
+Status](https://secure.travis-ci.org/nelmio/NelmioApiDocBundle.png?branch=master)](http://travis-ci.org/nelmio/NelmioApiDocBundle)
+[![Total Downloads](https://poser.pugx.org/nelmio/api-doc-bundle/downloads)](https://packagist.org/packages/nelmio/api-doc-bundle)
+[![Latest Stable
+Version](https://poser.pugx.org/nelmio/api-doc-bundle/v/stable)](https://packagist.org/packages/nelmio/api-doc-bundle)
+
+The **NelmioApiDocBundle** bundle allows you to generate a decent documentation
+for your APIs.
 
 ## Installation
 
@@ -44,13 +52,13 @@ $swagger = $generator->generate()->toArray();
 ## What's supported?
 
 This bundle supports _Symfony_ route requirements, PHP annotations,
+[the `ApiDoc` annotation](https://github.com/nelmio/NelmioApiDocBundle/blob/master/Annotation/ApiDoc.php),
 [_Swagger-Php_](https://github.com/zircote/swagger-php) annotations,
-[_NelmioApiDocBundle_](https://github.com/nelmio/NelmioApiDocBundle) annotation,
 [_FOSRestBundle_](https://github.com/FriendsOfSymfony/FOSRestBundle) annotations and
 [_Api-Platform_](https://github.com/api-platform/api-platform) apps.
 
 This bundle is a **Work In Progress** and as such it does only support input
-documentation for now (if you use _Swagger-Php_ or _Api-Platform_ output is supported as well).
+documentation for now (if you use _Swagger-Php_ or _Api-Platform_, output is supported as well).
 
 ## What's next?
 
@@ -59,3 +67,28 @@ manage models that can vary based on several factors (serialization
 groups, class, etc.) and then put it in the app's documentation.
 
 Other libraries support might be added but the priority is to finalize the bundle first.
+
+## Contributing
+
+See
+[CONTRIBUTING](https://github.com/nelmio/NelmioApiDocBundle/blob/master/CONTRIBUTING.md)
+file.
+
+
+## Running the Tests
+
+Install the [Composer](http://getcomposer.org/) dependencies:
+
+    git clone https://github.com/nelmio/NelmioApiDocBundle.git
+    cd NelmioApiDocBundle
+    composer update
+
+Then, run the test suite using
+[PHPUnit](https://github.com/sebastianbergmann/phpunit/):
+
+    phpunit
+
+
+## License
+
+This bundle is released under the MIT license.