Skip to content

docs: align contributing guide with CI checks #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marandaneto merged 1 commit into from
Apr 17, 2026
Merged

docs: align contributing guide with CI checks #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,26 @@ Thanks for your interest in improving the PostHog PHP SDK.
## Development setup

1. Install [PHP](https://www.php.net/manual/en/install.php) and [Composer](https://getcomposer.org/download/).
2. Install dependencies:
2. Install dependencies using the same command CI uses:

```bash
php composer.phar update
composer install --prefer-dist --no-progress
```

3. Run the test suite:
## CI-aligned checks

```bash
bin/test
```
Run the test command used in CI:

```bash
XDEBUG_MODE=coverage ./vendor/bin/phpunit --bootstrap vendor/autoload.php --configuration phpunit.xml --coverage-text
```

CI also runs PHP_CodeSniffer with `phpcs.xml`. You can run an equivalent local check with:

This script runs `./vendor/bin/phpunit --verbose test`.
```bash
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
php phpcs.phar --standard=phpcs.xml --extensions=php .
```

## Pull requests

Expand Down
Loading