The PHPMD project welcomes your contribution. There are several ways to help out:
- Create an issue on GitHub, if you have found a bug or have an idea for a feature
- Write test cases for open bug issues
- Write patches for open bug/feature issues
- Participate on the PHPMD Gitter Channel
There are a few guidelines that we need contributors to follow, so that we have a chance of keeping on top of things.
- The code must follow the coding standard, that is based on PSR-2 coding standard with additional rules.
- All code changes should be covered by unit tests
- Submit an issue
- Make sure it does not already exist.
- Clearly describe the issue including steps to reproduce, when it is a bug.
- Make sure you note the PHPMD version you use.
- Use one of the issue templates.
Make sure your code changes comply with the coding standard by using PHP Codesniffer from within your PHPMD folder:
vendor/bin/phpcs -p --extensions=php src > phpcs.txt
Linux / OS X users may extend this command to exclude files, that are not part of a commit:
vendor/bin/phpcs -p --extensions=php --ignore=src/tests/resources $(git ls-files -om --exclude-standard | grep '\.php$') > phpcs.txt
Check the phpcs.txt once it finished.