Skip to content

Commit 4eb49e8

Browse files
committed
Updates descriptions
1 parent 5ea9761 commit 4eb49e8

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ you must follow these rules.
1313

1414
If you think a feature is missing, please report it or even better implement it :). If you report it, describe the more
1515
precisely what you would like to see implemented and we will discuss what is the best approach for it. If you can do
16-
some search before submitting it and link the resources to your description, you're awesome! It will allow me to more
16+
some search before submitting it and link the resources to your description, you're awesome! It will allow us to more
1717
easily understood/implement it.
1818

1919

@@ -22,7 +22,8 @@ easily understood/implement it.
2222
If you think you have detected a bug or a doc issue, please report it or even better fix it :). If you report it,
2323
please be the more precise possible. Here a little list of required informations:
2424

25-
* Precise description of the bug.
25+
- Precise description of the bug
26+
- Details of your environment
2627

2728

2829
## Bug fix
@@ -42,8 +43,8 @@ $ composer install
4243
```
4344

4445
When you're on the new branch with the dependencies, code as much as you want and when the fix is ready, don't commit
45-
it immediately. Before, you will need to add tests and update the doc. For the tests, everything is tested with
46-
[PHPUnit](http://phpunit.de/) and the doc is in the markdown format under the `doc` directory.
46+
it immediately. Before, you will need to add tests and update the documentation. For the tests, everything is tested with
47+
[PHPUnit](http://phpunit.de/), the documentation is in markdown format in the `gh-pages` branch.
4748

4849
To run the tests, use the following command:
4950

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ $ composer require php-http/adapter
2222

2323
## Usage
2424

25+
This is the contract package for HTTP Adapter. It should be used when implementing a custom HTTP Adapter or to rely on a stable version of interfaces.
26+
27+
There is also a virtual package which is versioned together with this contract package: [php-http/adapter-implementation](https://packagist.org/providers/php-http/adapter-implementation).
28+
2529

2630
## Testing
2731

0 commit comments

Comments
 (0)