Skip to content

Commit 5b3be1f

Browse files
committed
Add contributing instructions
See #147 Signed-off-by: Michal Čihař <[email protected]>
1 parent e340cd0 commit 5b3be1f

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to SQL Parser
2+
3+
## Reporting issues
4+
5+
Our issue tracker is hosted at GitHub:
6+
7+
https://github.com/phpmyadmin/sql-parser/issues
8+
9+
Please search for existing issues before reporting new ones.
10+
11+
## Working with Git checkout
12+
13+
The dependencies are managed by Composer, to get them all installed (or update
14+
on consequent runs) do:
15+
16+
```
17+
composer update
18+
```
19+
20+
## Submitting patches
21+
22+
Please submit your patches using GitHub pull requests, this allows us to review
23+
them and to run automated tests on the code.
24+
25+
## Coding standards
26+
27+
We do follow PSR-1 and PSR-2 coding standards.
28+
29+
You can use php-cs-fixer to fix the code to match our expectations:
30+
31+
```
32+
php-cs-fixer fix .
33+
```
34+
35+
## Testsuite
36+
37+
Our code comes with quite comprehensive testsuite, it is automatically executed
38+
on every commit and pull request, you can also run it locally:
39+
40+
```
41+
./vendor/bin/phpunit -c phpunit.xml
42+
```

0 commit comments

Comments
 (0)