cakephp-tools/docs/Contributing.md

Contributing

Getting Started

• Make sure you have a GitHub account
• Fork the repository on GitHub.

Making Changes

I am looking forward to your contributions. There are several ways to help out:

• Write missing testcases
• Write patches for bugs/features, preferably with testcases included

There are a few guidelines that I need contributors to follow:

• Coding standards (see link below)
• Passing tests (you can enable travis to assert your changes pass) for Windows and Unix

Protip: Use my MyCakePHP sniffs to assert coding standards are met. You can either use this pre-build repo and the convenience shell command cake CodeSniffer.CodeSniffer run -p Tools --standard=MyCakePHP or the manual phpcs --standard=MyCakePHP /path/to/Tools.

Additional Resources

• Coding standards guide (extending/overwriting the CakePHP ones)
• CakePHP coding standards
• General GitHub documentation
• GitHub pull request documentation