| commit | author | age | ||
| 2207d6 | 1 | # How to contribute |
| W | 2 | |
| 3 | At Codeception we are glad to receive contributions and patches from the community. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. | |
| 4 | ||
| 5 | Please check the guide for sending your contributions with Github at | |
| 6 | https://github.com/Codeception/Codeception/wiki/Git-workflow-for-Codeception-contributors | |
| 7 | ||
| 8 | ## Coding Standards | |
| 9 | All contributions must follow [PSR-2](http://www.php-fig.org/psr/psr-2/) coding standard. | |
| 10 | ||
| 11 | ## Code | |
| 12 | **Bugfixes should be sent to to current stable branch, which is the same as major version number.** | |
| 13 | ||
| 14 | Breaking features and major improvements should be sent into `master`. When you send PRs to master, they will be added to release cycle only when the next stable branch is started. | |
| 15 | ||
| 16 | ## Tests | |
| 17 | ||
| 18 | Check the [tests/README.md](tests/README.md) to learn how to run and write internal tests. | |
| 19 | We encourage you to write a test for a patch you are implementing. If this doesn't seem possible, such PRs are stil valid and can be accepted. | |
| 20 | ||
| 21 | We also encourage to submit bug reports with a failing test or test environment (3rd party repo with Codeception installation) with demonstration of a failure. That makes easier to us to find the cause and fix it. | |
| 22 | ||
| 23 | ## Documentation | |
| 24 | ||
| 25 | ### Guides | |
| 26 | If you want to contribute documentation to the guides you are asked to send your changes to the /docs/ folder: https://github.com/Codeception/Codeception/tree/2.2/docs. Theses files are the source for the codeception website guides: http://codeception.com/docs/01-Introduction. Remind to send your documentation improvements to the right "repository branch" depending on the Codeception version you are working with: 2.2, master,... | |
| 27 | ||
| 28 | ### Modules Documentation | |
| 29 | The documentation for each module is directly generated from the corresponding docblock which can be found in each module (src/Codeception/Module/*.php). | |
