Skip to content

Commit 192637a

Browse files
committed
[docs] add contribution doc.
1 parent ddf6275 commit 192637a

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

docs/contribution.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contribution
2+
3+
To contribute you have to fork a [enqueue-dev](https://github.com/php-enqueue/enqueue-dev) repository.
4+
Clone it locally.
5+
6+
## Setup environment
7+
8+
```
9+
composer install
10+
./bin/pre-commit -i
11+
./bin/dev -b
12+
```
13+
14+
Once you did it you can work on a feature or bug fix.
15+
16+
## Testing
17+
18+
To run tests simply run
19+
20+
```
21+
./bin/dev -t
22+
```
23+
24+
## Commit
25+
26+
When you try to commit changes `php-cs-fixer` is run. It fixes all coding style issues. Dont forget to stage them and commit everything.
27+
Once everything is done open a pull request on official repository.
28+
29+
[back to index](index.md)

docs/index.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,7 @@
2222
- [Consumption extension](bundle/consumption_extension.md)
2323
- [Production settings](bundle/production_settings.md)
2424
- [Debuging](bundle/debuging.md)
25-
- [Functional testing](bundle/functional_testing.md)
25+
- [Functional testing](bundle/functional_testing.md)
26+
* Development
27+
- [Contribution](contribution.md)
28+

0 commit comments

Comments
 (0)