Skip to content

Commit

Permalink
docs(contributing): add coverage report html section
Browse files Browse the repository at this point in the history
  • Loading branch information
Orkuncakilkaya committed Sep 2, 2024
1 parent 71953b6 commit 7d8fed3
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can just run `sh ./scripts/generate.sh` script and it will do all the work.

To download fresh OpenAPI schema run `sh ./scripts/sync.sh`

## Creating Coverage Report
## Creating Coverage Report (Markdown)

To generate a code coverage report in markdown format, follow these steps:

Expand All @@ -32,6 +32,17 @@ To generate a code coverage report in markdown format, follow these steps:

The markdown report will be saved in the cov/markdown/coverage_report.md file. You can open this file to review the coverage details.

## Creating Coverage Report (HTML)

To generate a code coverage report in HTML format, just run this command:

Run PHPUnit with the `--coverage-html` option to generate a coverage report in Clover HTML format:
```shell
docker-compose run phpunit --coverage-html=cov/html
```

The markdown report will be saved in the cov/markdown/coverage_report.md file. You can open this file to review the coverage details.

### Testing the local source code of the SDK

Use the `run_checks.php` file to make API requests using the local version of the SDK.
Expand Down

0 comments on commit 7d8fed3

Please sign in to comment.