@@ -8,25 +8,32 @@ changes.
88
99All PHP code must adhere to the [ PSR-2] standards.
1010
11+ [ PSR-2 ] : https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
12+
1113## Branching and pull requests
1214
1315As a guideline, please follow this process:
1416
15- 1 . [ Fork the repository] .
16- 2 . Create a topic branch for the change:
17- - New features should branch from ** develop** .
18- - Bug fixes to existing versions should branch from ** master** .
19- - Please ensure the branch is clearly labelled as a feature or fix.
20- 3 . Make the relevant changes.
21- 4 . [ Squash] commits if necessary.
22- 4 . Submit a pull request to the ** develop** branch.
23-
24- Please note this is a general guideline only. For more information on the
25- branching structure please see the [ git-flow cheatsheet] .
26-
27- <!-- References -->
17+ 1 . [ Fork the repository] .
18+ 2 . Create a topic branch for the change, branching from ** develop**
19+ (` git checkout -b branch-name develop ` ).
20+ 3 . Make the relevant changes.
21+ 4 . [ Squash] commits if necessary (` git rebase -i develop ` ).
22+ 5 . Submit a pull request to the ** develop** branch.
2823
2924[ Fork the repository ] : https://help.github.com/articles/fork-a-repo
30- [ git-flow cheatsheet ] : http://danielkummer.github.com/git-flow-cheatsheet/
31- [ PSR-2 ] : https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
3225[ Squash ] : http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
26+
27+ ## Tests
28+
29+ - Run the tests with ` vendor/bin/phpunit path/to/tests ` , or simply
30+ ` vendor/bin/phpunit ` to run the entire suite.
31+ - Generate a coverage report with
32+ ` vendor/bin/phpunit -c phpunit.coverage.xml path/to/tests ` , or simply
33+ ` vendor/bin/phpunit -c phpunit.coverage.xml ` to generate coverage for the
34+ entire suite. The coverage report will be created at
35+ ` artifacts/tests/coverage/index.html ` .
36+ - Run the integration tests with ` test/integration/run-all ` . Each test suite has
37+ one passing, and one failing test. This demonstrates * Phony* 's output.
38+ - Run the benchmarks with ` vendor/bin/athletic -p test/benchmarks ` . This
39+ compares * Phony* 's performance with other mocking frameworks.
0 commit comments