Skip to content

Commit cf6c18d

Browse files
committed
Add contributing info
1 parent ca426b6 commit cf6c18d

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing to phpmarkup
2+
3+
First off, thanks for taking the time to contribute!
4+
5+
For local package development use [Docker](https://www.docker.com/products/docker-desktop):
6+
7+
Build Test container
8+
```
9+
git clone https://github.com/Ouxsoft/phpmarkup.git
10+
cd phpmarkup
11+
docker build --target test --tag phpmarkup:latest -f Dockerfile .
12+
docker run -it --mount type=bind,source="$(pwd)"/,target=/application/ phpmarkup:latest composer install
13+
```
14+
15+
Run Automated Unit Tests using local volume
16+
```
17+
docker run -it --mount type=bind,source="$(pwd)"/,target=/application/ phpmarkup:latest composer test
18+
```
19+
20+
Run Automated Benchmark Tests using local volume
21+
```
22+
docker run -it --mount type=bind,source="$(pwd)"/,target=/application/ phpmarkup:latest ./vendor/bin/phpbench run tests/src/Benchmark --report=default
23+
```
24+
25+
Rebuild Docs
26+
```
27+
docker build --target docs --tag phpmarkup:docs-latest -f Dockerfile .
28+
docker run -it --mount type=bind,source="$(pwd)"/docs,target=/app/docs phpmarkup:docs-latest bash -c "doxygen Doxyfile && doxyphp2sphinx Ouxsoft::phpmarkup"
29+
```

0 commit comments

Comments
 (0)