You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-9Lines changed: 10 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -4,28 +4,29 @@ Contributions are welcome, and are accepted via pull requests. Please review the
4
4
5
5
## Guidelines
6
6
7
-
* Please follow the [PSR-2 Coding Standard](http://php-fig.org/psr/psr-2) and [PHP-FIG Naming Conventions](http://php-fig.org/bylaws/psr-naming-conventions).
8
-
* Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
9
-
* Remember that we follow [SemVer](http://semver.org). If you are changing the behavior, or the public api, you may need to update the docs.
10
-
* Send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash](https://git-scm.com/book/en/Git-Tools-Rewriting-History) them before submitting.
11
-
* You may also need to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing) to avoid merge conflicts.
7
+
- Please follow the [PSR-2 Coding Style Guide](http://www.php-fig.org/psr/psr-2), enforced by [StyleCI](https://styleci.io).
8
+
- Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
9
+
- Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
10
+
- You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
11
+
- If you are changing the behavior, or the public api, you may need to update the docs.
12
+
- Please remember that we follow [SemVer](http://semver.org).
12
13
13
14
## Running Tests
14
15
15
16
You will need an install of [Composer](https://getcomposer.org) before continuing.
16
17
17
18
First, install the dependencies:
18
19
19
-
```bash
20
+
```sh
20
21
$ composer install
21
22
```
22
23
23
-
Then run PHPUnit:
24
+
Then run [PHPUnit](https://phpunit.de):
24
25
25
-
```bash
26
+
```sh
26
27
$ vendor/bin/phpunit
27
28
```
28
29
29
30
If the test suite passes on your local machine you should be good to go.
30
31
31
-
When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org/) on multiple PHP versions.
32
+
When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org).
0 commit comments