diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca0aa3b..bb2b634 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,15 @@ -Contributing +CONTRIBUTING ============ -Welcome to the contribution guide for Factory Muffin Faker. Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests. - - -## Which Branch? - -* Please submit all pull requests for new features to the master branch. -* Please submit pull requests for bug fixes and typos to the earliest branch the issue can be found in. +Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests. ## Guidelines * 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). * 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 behaviour, or the public api, you may need to update the docs. +* 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](http://git-scm.com/book/en/Git-Tools-Rewriting-History) them before submitting. * You may also need to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) to avoid merge conflicts. @@ -30,7 +24,7 @@ First, install the dependencies: $ composer install ``` -Then run phpunit: +Then run PHPUnit: ```bash $ vendor/bin/phpunit @@ -38,4 +32,6 @@ $ 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 and hhvm. +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. + +We also have StyleCI setup to automatically check and fix any code style issues. diff --git a/LICENSE b/LICENSE index 2f6ea06..ac1e8c2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2014-2015 Graham Campbell +Copyright (c) 2014-2016 Graham Campbell Copyright (c) 2014-2015 Scott Robertson Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/README.md b/README.md index 4d45b76..663ad10 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,11 @@ Note that this library does not actually require Factory Muffin in order to work [PHP](https://php.net) 5.4+ and [Composer](https://getcomposer.org) are required. -In your composer.json, simply add `"league/factory-muffin-faker": "~1.0"` to your `"require-dev"` section: +In your composer.json, simply add `"league/factory-muffin-faker": "^1.0"` to your `"require-dev"` section: ```json { "require-dev": { - "league/factory-muffin-faker": "~1.0" + "league/factory-muffin-faker": "^1.0" } } ```