mirror of
https://github.com/Llewellynvdm/php-ml.git
synced 2024-09-22 04:09:01 +00:00
a348111e97
* tests: update to PHPUnit 6.0 with rector * fix namespaces on tests * composer + tests: use standard test namespace naming * update travis * resolve conflict * phpstan lvl 2 * phpstan lvl 3 * phpstan lvl 4 * phpstan lvl 5 * phpstan lvl 6 * phpstan lvl 7 * level max * resolve conflict * [cs] clean empty docs * composer: bump to PHPUnit 6.4 * cleanup * composer + travis: add phpstan * phpstan lvl 1 * composer: update dev deps * phpstan fixes * update Contributing with new tools * docs: link fixes, PHP version update * composer: drop php-cs-fixer, cs already handled by ecs * ecs: add old set rules * [cs] apply rest of rules
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
# Contributing to PHP-ML
|
|
|
|
PHP-ML is an open source project. If you'd like to contribute, please read the following text. Before I can merge your
|
|
Pull-Request here are some guidelines that you need to follow. These guidelines exist not to annoy you, but to keep the
|
|
code base clean, unified and future proof.
|
|
|
|
## Branch
|
|
|
|
You should only open pull requests against the `master` branch.
|
|
|
|
## Unit-Tests
|
|
|
|
Please try to add a test for your pull-request. You can run the unit-tests by calling:
|
|
|
|
```bash
|
|
vendor/bin/phpunit
|
|
```
|
|
|
|
## Travis
|
|
|
|
GitHub automatically run your pull request through Travis CI.
|
|
If you break the tests, I cannot merge your code, so please make sure that your code is working before opening up a Pull-Request.
|
|
|
|
## Merge
|
|
|
|
Please allow me time to review your pull requests. I will give my best to review everything as fast as possible, but cannot always live up to my own expectations.
|
|
|
|
## Coding Standards & Static Analysis
|
|
|
|
When contributing code to PHP-ML, you must follow its coding standards. To do that, just run:
|
|
|
|
```bash
|
|
vendor/bin/ecs check src tests --fix
|
|
```
|
|
[More about EasyCodingStandard](https://github.com/Symplify/EasyCodingStandard)
|
|
|
|
Code has to also pass static analysis by [PHPStan](https://github.com/phpstan/phpstan):
|
|
|
|
```bash
|
|
vendor/bin/phpstan.phar analyse src tests --level max --configuration phpstan.neon
|
|
```
|
|
|
|
|
|
## Documentation
|
|
|
|
Please update the documentation pages if necessary. You can find them in docs/.
|
|
|
|
---
|
|
|
|
Thank you very much again for your contribution!
|