Implement PHP code standard and formatter
AtoM has a custom coding standard that is not compatible with predominant PHP coding standards, e.g. PSR-1, PSR-12, Symfony's CS. Because the AtoM CS is idiosyncratic it requires extensive configuration to automate code formatting with a PHP code formatter. Maintaining unique coding standards for AtoM also requires maintaining independent documentation of the standard, and PHP developers that want to contribute code to the project must learn a new and niche coding standard.
- Select an existing PHP coding standard and code formatting tool that can implement the chosen standard with minimal configuration
- Configure the chosen code formatter to implement the chosen coding standard, and run the tool to reformat the existing AtoM code (in a dev branch)
- Do QA testing of the re-formatted AtoM code, to make sure the formatter hasn't broken any functionality
- Merge the re-formatted dev branch to the current main (qa) branch
- Set up a continuous integration script to validate new code against the coding standard before the code can be merged to the main "stable" and "qa" branches of AtoM
- Document usage of the code formatter and configuration to enable developers to use the formatter to automate formatting of code contributed to AtoM