add readme and boilerplate files

dbu · dbu · commit c068832efa79 · 2015-08-24T13:42:20.000+02:00
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,7 @@
+.editorconfig    export-ignore
+.gitattributes   export-ignore
+.gitignore       export-ignore
+.scrutinizer.yml export-ignore
+.travis.yml      export-ignore
+CONTRIBUTING.md  export-ignore
+Tests/           export-ignore
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+vendor/
+composer.lock
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,11 @@
+filter:
+  exclude_paths: [vendor/*, Tests/*]
+checks:
+  php:
+    code_rating: true
+    duplication: true
+tools:
+  external_code_coverage: true
+  php_code_sniffer:
+    config:
+      standard: "PSR2"
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,37 @@
+language: php
+
+php:
+  - 5.4
+  - 5.5
+  - 5.6
+  - 7.0
+  - hhvm
+
+env:
+  global:
+    - TEST_COMMAND="composer test"
+
+matrix:
+  allow_failures:
+    - php: 7.0
+  fast_finish: true
+  include:
+    - php: 5.4
+      env:
+        - COMPOSER_FLAGS="--prefer-stable --prefer-lowest"
+        - COVERAGE=true
+        - TEST_COMMAND="composer test-ci"
+
+before_install:
+  - travis_retry composer self-update
+
+install:
+  - travis_retry composer update ${COMPOSER_FLAGS} --prefer-source --no-interaction
+
+script:
+  - $TEST_COMMAND
+
+after_success:
+  - if [[ "$COVERAGE" = true ]]; then wget https://scrutinizer-ci.com/ocular.phar; fi
+  - if [[ "$COVERAGE" = true ]]; then php ocular.phar code-coverage:upload --format=php-clover build/coverage.xml; fi
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,85 @@
+# Contributing
+
+If you're here, you would like to contribute to this repository and you're really welcome!
+
+
+## Bug reports
+
+If you find a bug or a documentation issue, please report it or even better: fix it :). If you report it,
+please be as precise as possible. Here is a little list of required information:
+
+ - Precise description of the bug
+ - Details of your environment (for example: OS, PHP version, installed extensions)
+ - Backtrace which might help identifing the bug
+
+
+## Security issues
+
+If you discover any security related issues, please contact us at [security@php-http.org](mailto:security@php-http.org) instead of submitting an issue on Github. This allows us to fix the issue and release a security hotfix without publicly disclosing the vulnerability.
+
+
+## Feature requests
+
+If you think a feature is missing, please report it or even better: implement it :). If you report it, describe the more
+precisely what you would like to see implemented and we will discuss what is the best approach for it. If you can do
+some research before submitting it and link the resources to your description, you're awesome! It will allow us to more
+easily understood/implement it.
+
+
+## Sending a Pull Request
+
+If you're here, you are going to fix a bug or implement a feature and you're the best! To do it, first fork the repository, clone it and create a new branch with the following commands:
+
+``` bash
+$ git clone git@github.com:your-name/repo-name.git
+$ git checkout -b feature-or-bug-fix-description
+```
+
+Then install the dependencies through [Composer](https://getcomposer.org/):
+
+``` bash
+$ composer install
+```
+
+Write code and tests. When you are ready, run the tests. (This is usually [PHPUnit](http://phpunit.de/) or [PHPSpec](http://phpspec.net/))
+
+``` bash
+$ composer test
+```
+
+When you are ready with the code, tested it and documented it, you can commit and push it with the following commands:
+
+``` bash
+$ git commit -m "Feature or bug fix description"
+$ git push origin feature-or-bug-fix-description
+```
+
+**Note:** Please write your commit messages in the imperative and follow the [guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for clear and concise messages.
+
+Then [create a pull request](https://help.github.com/articles/creating-a-pull-request/) on GitHub.
+
+Please make sure that each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting with the following commands (here, we assume you would like to squash 3 commits in a single one):
+
+``` bash
+$ git rebase -i HEAD~3
+```
+
+If your branch conflicts with the master branch, you will need to rebase and repush it with the following commands:
+
+``` bash
+$ git remote add upstream git@github.com:php-http/repo-name.git
+$ git pull --rebase upstream master
+$ git push -f origin feature-or-bug-fix-description
+```
+
+
+## Coding standard
+
+This repository follows the [PSR-2 standard](http://www.php-fig.org/psr/psr-2/) and so, if you want to contribute,
+you must follow these rules.
+
+
+## Semver
+
+We are trying to follow [semver](http://semver.org/). When you are making BC breaking changes, please let us know why you think it is important. In this case, your patch can only be included in the next major version.
+
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2015 PHP HTTP Team <team@php-http.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,46 @@
+# PhpHttpBundle
+
+[![Latest Version](https://img.shields.io/github/release/php-http/PhpHttpBundle.svg?style=flat-square)](https://github.com/php-http/PhpHttpBundle/releases)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
+[![Build Status](https://img.shields.io/travis/php-http/PhpHttpBundle.svg?style=flat-square)](https://travis-ci.org/php-http/PhpHttpBundle)
+[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/php-http/PhpHttpBundle.svg?style=flat-square)](https://scrutinizer-ci.com/g/php-http/PhpHttpBundle)
+[![Quality Score](https://img.shields.io/scrutinizer/g/php-http/PhpHttpBundle.svg?style=flat-square)](https://scrutinizer-ci.com/g/php-http/PhpHttpBundle)
+[![Total Downloads](https://img.shields.io/packagist/dt/php-http/PhpHttpBundle.svg?style=flat-square)](https://packagist.org/packages/php-http/PhpHttpBundle)
+
+**Symfony integration for the [php-http](http://php-http.readthedocs.org/) system**
+
+This is early work in progress for now. See the issues for a plan and discussion what should be done.
+
+
+## Install
+
+Via Composer
+
+``` bash
+$ composer require php-http/php-http-bundle
+```
+
+
+## Usage
+
+
+## Testing
+
+``` bash
+$ composer test
+```
+
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+
+## Security
+
+If you discover any security related issues, please contact us at [security@php-http.org](mailto:security@php-http.org).
+
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.
