forked from slimphp/Slim-Http
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
75 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# How to Contribute | ||
|
||
## Pull Requests | ||
|
||
1. Fork this repository | ||
2. Create a new branch for each feature or improvement | ||
3. Send a pull request from each feature branch to the **master** branch | ||
|
||
It is very important to separate new features or improvements into separate | ||
feature branches, and to send a pull request for each branch. This allows me to | ||
review and pull in new features or improvements individually. | ||
|
||
## Style Guide | ||
|
||
All pull requests must adhere to the [PSR-2 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md). | ||
|
||
## Unit Testing | ||
|
||
All pull requests must be accompanied by passing unit tests and complete code | ||
coverage. The Slim Framework uses phpunit for testing. | ||
|
||
[Learn about PHPUnit](https://github.com/sebastianbergmann/phpunit/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,54 @@ | ||
# Slim-Http | ||
Strict PSR-7 implementation | ||
|
||
Strict PSR-7 implementation used by the Slim Framework, but you may use it | ||
separately with any framework compatible with the PSR-7 standard. | ||
|
||
[](https://travis-ci.org/slimphp/Slim-Http) | ||
[](https://coveralls.io/r/slimphp/Slim-Http?branch=master) | ||
[](https://packagist.org/packages/slim/http) | ||
[](https://packagist.org/packages/slim/http) | ||
|
||
## Installation | ||
|
||
It's recommended that you use [Composer](https://getcomposer.org/) to install | ||
this library. | ||
|
||
```bash | ||
$ composer require slim/http "^0.1" | ||
``` | ||
|
||
This will install the `slim/http` component and all required dependencies. | ||
PHP 5.5.0 or newer is required. | ||
|
||
## Usage | ||
|
||
Coming soon. | ||
|
||
## Tests | ||
|
||
To execute the test suite, you'll need phpunit. | ||
|
||
```bash | ||
$ phpunit | ||
``` | ||
|
||
## Contributing | ||
|
||
Please see [CONTRIBUTING](CONTRIBUTING.md) for details. | ||
|
||
## Security | ||
|
||
If you discover security related issues, please email [email protected] | ||
instead of using the issue tracker. | ||
|
||
## Credits | ||
|
||
- [Josh Lockhart](https://github.com/codeguy) | ||
- [Andrew Smith](https://github.com/silentworks) | ||
- [Rob Allen](https://github.com/akrabat) | ||
- [All Contributors](../../contributors) | ||
|
||
## License | ||
|
||
This component is licensed under the MIT license. See [License File](LICENSE.md) | ||
for more information. |