Skip to content
This repository was archived by the owner on Feb 6, 2020. It is now read-only.

Commit de949c3

Browse files
committed
Updated CONTRIBUTING.md
1 parent b027cdc commit de949c3

File tree

1 file changed

+13
-23
lines changed

1 file changed

+13
-23
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -36,33 +36,24 @@ For sensitive email communications, please use [our PGP key](http://framework.ze
3636

3737
## RUNNING TESTS
3838

39-
> ### Note: testing versions prior to 2.4
40-
>
41-
> This component originates with Zend Framework 2. During the lifetime of ZF2,
42-
> testing infrastructure migrated from PHPUnit 3 to PHPUnit 4. In most cases, no
43-
> changes were necessary. However, due to the migration, tests may not run on
44-
> versions < 2.4. As such, you may need to change the PHPUnit dependency if
45-
> attempting a fix on such a version.
46-
4739
To run tests:
4840

4941
- Clone the repository:
5042

5143
```console
52-
$ git clone git@github.com:zendframework/zend-servicemanager.git
53-
$ cd
44+
$ git clone git://github.com/zendframework/zend-servicemanager.git
45+
$ cd zend-servicemanager
5446
```
5547

5648
- Install dependencies via composer:
5749

5850
```console
59-
$ curl -sS https://getcomposer.org/installer | php --
60-
$ ./composer.phar install
51+
$ composer install
6152
```
6253

63-
If you don't have `curl` installed, you can also download `composer.phar` from https://getcomposer.org/
54+
If you don't have `composer` installed, please download it from https://getcomposer.org/download/
6455

65-
- Run the tests:
56+
- Run the tests using the "test" command shipped in the `composer.json`:
6657

6758
```console
6859
$ composer test
@@ -77,23 +68,22 @@ To do so:
7768

7869
## Running Coding Standards Checks
7970

80-
This component follows [PSR-1](http://www.php-fig.org/psr/psr-1/) and
81-
[PSR-2](http://www.php-fig.org/psr/psr-2/) guidelines, and ships with tooling
82-
for both checking code against standards, as well as fixing most errors.
71+
First, ensure you've installed dependencies via composer, per the previous
72+
section on running tests.
8373

84-
To run checks only:
74+
To run CS checks only:
8575

8676
```console
8777
$ composer cs-check
8878
```
8979

90-
To fix common errors:
80+
To attempt to automatically fix common CS issues:
9181

9282
```console
9383
$ composer cs-fix
9484
```
9585

96-
If you allow tooling to fix CS issues, please re-run the tests to ensure
86+
If the above fixes any CS issues, please re-run the tests to ensure
9787
they pass, and make sure you add and commit the changes after verification.
9888

9989
## Recommended Workflow for Contributions
@@ -102,12 +92,12 @@ Your first step is to establish a public repository from which we can
10292
pull your work into the master repository. We recommend using
10393
[GitHub](https://github.com), as that is where the component is already hosted.
10494

105-
1. Setup a [GitHub account](http://github.com/), if you haven't yet
106-
2. Fork the repository (http://github.com/zendframework/zend-servicemanager)
95+
1. Setup a [GitHub account](https://github.com/), if you haven't yet
96+
2. Fork the repository (https://github.com/zendframework/zend-servicemanager)
10797
3. Clone the canonical repository locally and enter it.
10898

10999
```console
110-
$ git clone git://github.com:zendframework/zend-servicemanager.git
100+
$ git clone git://github.com/zendframework/zend-servicemanager.git
111101
$ cd zend-servicemanager
112102
```
113103

0 commit comments

Comments
 (0)