Skip to content

Commit

Permalink
Add contributing notes
Browse files Browse the repository at this point in the history
  • Loading branch information
adbario committed Mar 28, 2022
1 parent 43af3e1 commit eb3174b
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,27 @@ Returns all the stored items as JSON:
echo $dot->toJson();
```

## Contributing

### Pull Requests
1. Fork the Dot repository
2. Create a new branch for each feature or improvement
3. Send a pull request from each feature branch to the 3.x branch

It is very important to separate new features or improvements into separate feature branches, and to send a pull request for each branch. This allows me to review and pull in new features or improvements individually.

### Style Guide

All pull requests must adhere to the [PSR-12 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md).

### Unit Testing

All pull requests must be accompanied by passing unit tests and complete code coverage. Dot uses [PHPUnit](https://github.com/sebastianbergmann/phpunit/) for testing.

### Static Analysis

All pull requests must pass static analysis using [PHPStan](https://github.com/sebastianbergmann/phpunit/).

## License

[MIT license](LICENSE.md)

0 comments on commit eb3174b

Please sign in to comment.