php-ml/CONTRIBUTING.md

# 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:

```
bin/phpunit
```

## Travis

GitHub automatically run your pull request through Travis CI against PHP 7. 
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

When contributing code to PHP-ML, you must follow its coding standards. It's as easy as executing `./bin/php-cs-fixer fix` in root directory.

More about PHP-CS-Fixer: [http://cs.sensiolabs.org/](http://cs.sensiolabs.org/)

## Documentation

Please update the documentation pages if necessary. You can find them in docs/.

---

Thank you very much again for your contribution!
create contributing guide 2016-07-26 19:57:15 +00:00			`# 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`

php-cs-fixer (#85) Remove obsolete php-cs-fixer.sh script Update contributing guidelines 2017-05-13 10:57:32 +00:00			`You should only open pull requests against the master branch.`
create contributing guide 2016-07-26 19:57:15 +00:00
			`## Unit-Tests`

			`Please try to add a test for your pull-request. You can run the unit-tests by calling:`

			```
			`bin/phpunit`
			```

			`## Travis`

			`GitHub automatically run your pull request through Travis CI against PHP 7.`
			`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`

Require php-cs-fixer as dev dependency (#111) * require friendsofphp/php-cs-fixer as dev dependency * update contributing with php-cs-fixer example 2017-07-28 10:29:09 +00:00			When contributing code to PHP-ML, you must follow its coding standards. It's as easy as executing `./bin/php-cs-fixer fix` in root directory.
create contributing guide 2016-07-26 19:57:15 +00:00
			`More about PHP-CS-Fixer: [http://cs.sensiolabs.org/](http://cs.sensiolabs.org/)`

Note about updating docs in CONTRIBUTING.md (#39) 2017-02-01 12:52:36 +00:00			`## Documentation`

			`Please update the documentation pages if necessary. You can find them in docs/.`

create contributing guide 2016-07-26 19:57:15 +00:00			`---`

			`Thank you very much again for your contribution!`