Skip to content

Commit cfdbca4

Browse files
authored
docs: add contributing guide (#123)
docs: add contributing guides
1 parent 93ee12f commit cfdbca4

2 files changed

Lines changed: 25 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
Thanks for your interest in improving the PostHog PHP SDK.
4+
5+
## Development setup
6+
7+
1. Install [PHP](https://www.php.net/manual/en/install.php) and [Composer](https://getcomposer.org/download/).
8+
2. Install dependencies:
9+
10+
```bash
11+
php composer.phar update
12+
```
13+
14+
3. Run the test suite:
15+
16+
```bash
17+
bin/test
18+
```
19+
20+
This script runs `./vendor/bin/phpunit --verbose test`.
21+
22+
## Pull requests
23+
24+
Please follow the existing project conventions and include tests when you change behavior.

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,7 @@ Auto error tracking is off by default. When enabled, the SDK chains existing exc
6363

6464
## Contributing
6565

66-
1. [Download PHP](https://www.php.net/manual/en/install.php) and [Composer](https://getcomposer.org/download/)
67-
2. `php composer.phar update` to install dependencies
68-
3. `bin/test` to run tests (this script calls `./vendor/bin/phpunit --verbose test`)
66+
See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup and test instructions.
6967

7068
## Releasing
7169

0 commit comments

Comments
 (0)