Skip to content
This repository has been archived by the owner on Nov 8, 2023. It is now read-only.

Commit

Permalink
Update the contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
vinkla committed Jan 1, 2017
1 parent 23c702d commit 5aa7e18
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
19 changes: 10 additions & 9 deletions CONTRIBUTING.md
Expand Up @@ -4,28 +4,29 @@ Contributions are welcome, and are accepted via pull requests. Please review the

## Guidelines

* 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).
* Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
* 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.
* 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.
* You may also need to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing) to avoid merge conflicts.
- Please follow the [PSR-2 Coding Style Guide](http://www.php-fig.org/psr/psr-2), enforced by [StyleCI](https://styleci.io).
- Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
- Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
- You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
- If you are changing the behavior, or the public api, you may need to update the docs.
- Please remember that we follow [SemVer](http://semver.org).

## Running Tests

You will need an install of [Composer](https://getcomposer.org) before continuing.

First, install the dependencies:

```bash
```sh
$ composer install
```

Then run PHPUnit:
Then run [PHPUnit](https://phpunit.de):

```bash
```sh
$ vendor/bin/phpunit
```

If the test suite passes on your local machine you should be good to go.

When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org/) on multiple PHP versions.
When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org).
2 changes: 1 addition & 1 deletion composer.json
Expand Up @@ -15,7 +15,7 @@
"guzzlehttp/guzzle": "^6.2.1"
},
"require-dev": {
"phpunit/phpunit": "^5.6"
"phpunit/phpunit": "^5.7"
},
"autoload": {
"psr-4": {
Expand Down

0 comments on commit 5aa7e18

Please sign in to comment.