|
1 |
| -#A quick guide to contribute to the project: |
| 1 | +# A quick guide to contribute to the project: |
2 | 2 |
|
3 |
| -##Installing the dev environment |
| 3 | +## Installing the dev environment |
4 | 4 |
|
5 | 5 | 1. Fork the repo
|
6 | 6 | 2. Clone the repo to local
|
7 | 7 | 3. Install dependencies: `composer update` (this assumes you have 'composer' aliased to whereever your composer.phar lives)
|
8 | 8 | 4. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate:
|
9 | 9 | `./bin/phpunit`
|
10 | 10 |
|
11 |
| -##Coding Standards |
| 11 | +## Coding Standards |
12 | 12 |
|
13 | 13 | Try use similar coding standards to what you see in the project to keep things clear to the contributors. If you're unsure, it's always a safe bet to fall-back to the PSR standards.
|
14 | 14 |
|
15 | 15 | [PSR-1: Basic Coding Standard](http://www.php-fig.org/psr/psr-1/)
|
16 | 16 |
|
17 | 17 | [PSR-2: Coding Style Guide](http://www.php-fig.org/psr/psr-2/)
|
18 | 18 |
|
19 |
| -##Adding new features |
| 19 | +## Adding new features |
20 | 20 |
|
21 | 21 | Pull requests with new features needs to be created against master branch.
|
22 | 22 |
|
23 | 23 | If new feature require BC Breake please note that in your PR comment, it will added in next major version.
|
24 | 24 | New features that does not have any BC Breakes are going to be added in next minor version.
|
25 | 25 |
|
26 |
| -##Patches and bugfixes |
| 26 | +## Patches and bugfixes |
27 | 27 |
|
28 | 28 | 1. Check the oldest version that patch/bug fix can be applied.
|
29 | 29 | 2. Create PR against that version
|
30 | 30 |
|
31 | 31 | For example if you are fixing pattern expander that was introduced in version 1.1 make sure that PR with fix
|
32 | 32 | is created against version 1.1, not master or 2.0
|
33 | 33 |
|
34 |
| -##The actual contribution |
| 34 | +## The actual contribution |
35 | 35 |
|
36 | 36 | 1. Make the changes/additions to the code, committing often and making clear what you've done
|
37 | 37 | 2. Make sure you write tests for your code, located in the folder structure `tests/Coduo/PHPMatcher/...`
|
|
0 commit comments