Skip to content
This repository was archived by the owner on Jul 31, 2018. It is now read-only.

Commit a66ed47

Browse files
committed
Merge pull request #11 from forkify/contributing
Add CONTRIBUTING.md guidelines
2 parents 1371009 + c546631 commit a66ed47

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# CONTRIBUTING
2+
3+
Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.
4+
5+
## Guidelines
6+
7+
* Please follow the [PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) and [PHP-FIG Naming Conventions](https://github.com/php-fig/fig-standards/blob/master/bylaws/002-psr-naming-conventions.md).
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 behaviour, 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](http://git-scm.com/book/en/Git-Tools-Rewriting-History) them before submitting.
11+
* You may also need to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) to avoid merge conflicts.
12+
13+
14+
## Running Tests
15+
16+
You will need an install of [Composer](https://getcomposer.org) before continuing.
17+
18+
First, install the dependencies:
19+
20+
```bash
21+
$ composer install
22+
```
23+
24+
Then run phpunit:
25+
26+
```bash
27+
$ vendor/bin/phpunit
28+
```
29+
30+
If the test suite passes on your local machine you should be good to go.
31+
32+
When you make a pull request, the tests will automatically be run again by [Travis CI](https://travis-ci.org/) on multiple php versions and hhvm.

0 commit comments

Comments
 (0)