-
-
Notifications
You must be signed in to change notification settings - Fork 138
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ce39d9f
commit 07113f7
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# CONTRIBUTION GUIDELINES | ||
|
||
Contributions are **welcome** and will be fully **credited**. | ||
|
||
We accept contributions via pull requests on Github. Please review these guidelines before continuing. | ||
|
||
## Guidelines | ||
|
||
* Please follow the [PSR-2 Coding Style Guide](https://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 or adding to the behaviour or public api, you may need to update the docs. | ||
* Please remember that we follow [SemVer](https://semver.org/). | ||
|
||
## Running Tests | ||
|
||
First, install the dependencies using [Composer](https://getcomposer.org/): | ||
|
||
```bash | ||
$ composer install | ||
``` | ||
|
||
Then run [PHPUnit](https://phpunit.de/): | ||
|
||
```bash | ||
$ vendor/bin/phpunit | ||
``` | ||
|
||
* The tests will be automatically run by [Travis CI](https://travis-ci.org/) against pull requests. | ||
* We also have [StyleCI](https://styleci.io/) setup to automatically fix any code style issues. |