Skip to content

Commit eb3174b

Browse files
committed
Add contributing notes
1 parent 43af3e1 commit eb3174b

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,27 @@ Returns all the stored items as JSON:
440440
echo $dot->toJson();
441441
```
442442

443+
## Contributing
444+
445+
### Pull Requests
446+
1. Fork the Dot repository
447+
2. Create a new branch for each feature or improvement
448+
3. Send a pull request from each feature branch to the 3.x branch
449+
450+
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.
451+
452+
### Style Guide
453+
454+
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).
455+
456+
### Unit Testing
457+
458+
All pull requests must be accompanied by passing unit tests and complete code coverage. Dot uses [PHPUnit](https://github.com/sebastianbergmann/phpunit/) for testing.
459+
460+
### Static Analysis
461+
462+
All pull requests must pass static analysis using [PHPStan](https://github.com/sebastianbergmann/phpunit/).
463+
443464
## License
444465

445466
[MIT license](LICENSE.md)

0 commit comments

Comments
 (0)