Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GrahamCampbell committed Feb 14, 2016
1 parent 85ceee1 commit fd3074a
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 14 deletions.
18 changes: 7 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -30,12 +24,14 @@ First, install the dependencies:
$ composer install
```

Then run phpunit:
Then run PHPUnit:

```bash
$ 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.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014-2015 Graham Campbell <[email protected]>
Copyright (c) 2014-2016 Graham Campbell <[email protected]>
Copyright (c) 2014-2015 Scott Robertson <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
```
Expand Down

0 comments on commit fd3074a

Please sign in to comment.