File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Contributing to Respect\Rest
2+
3+ Contributions to Respect\Rest are always welcome. You make our lives easier by
4+ sending us your contributions through GitHub pull requests.
5+
6+ Pull requests for bug fixes must be based on the current stable branch whereas
7+ pull requests for new features must be based on ` master ` .
8+
9+ Due to time constraints, we are not always able to respond as quickly as we
10+ would like. Please do not take delays personal and feel free to remind us here,
11+ on IRC, or on Gitter if you feel that we forgot to respond.
12+
13+ ## Using Respect\Rest From a Git Checkout
14+
15+ The following commands can be used to perform the initial checkout of Respect\Rest:
16+
17+ ``` shell
18+ git clone git://github.com/Respect/Rest.git
19+ cd Rest
20+ ```
21+
22+ Retrieve Respect\Rest's dependencies using [ Composer] ( http://getcomposer.org/ ) :
23+
24+ ``` shell
25+ composer install
26+ ```
27+
28+ ## Running Tests
29+
30+ After run ` composer install ` on the library's root directory you must run PHPUnit.
31+
32+ ### Linux
33+
34+ You can test the project using the commands:
35+ ``` shell
36+ $ vendor/bin/phpunit
37+ ```
38+
39+ ### Windows
40+
41+ You can test the project using the commands:
42+ ``` shell
43+ > vendor\b in\p hpunit
44+ ```
45+
46+ No test should fail.
47+
48+ You can tweak the PHPUnit's settings by copying ` phpunit.xml.dist ` to ` phpunit.xml `
49+ and changing it according to your needs.
50+
51+ ## Standards
52+
53+ We are trying to follow the [ PHP-FIG] ( http://www.php-fig.org ) 's standards, so
54+ when you send us a pull request, be sure you are following them.
55+
56+ ## Sending your code to us
57+
58+ Please see http://help.github.com/pull-requests/ .
You can’t perform that action at this time.
0 commit comments