joomla-projects / soc21_guided-tour

GNU General Public License v2.0
6 stars 11 forks source link

Overall Code Cleaning #23

Open particthistle opened 3 years ago

particthistle commented 3 years ago

Before the Guided Tours component is included in Joomla 4.1, it will require a code clean up and audit to make sure everything is correctly formatted and working efficiently.

Review the code against Joomla's coding standards to ensure everything is in order. https://developer.joomla.org/coding-standards/basic-guidelines.html Note that page tonight has an issue due to Github deprecating an authentication method... should be back up by the weekend.

jatinS-dev commented 3 years ago

I always use Joomla Coding Standards before committing the code, so this ain't a big issue here. Benjamin shared this in the starting only to set up the Joomla Coding Standards environment in my local environment machine.

Used this https://docs.joomla.org/Joomla_CodeSniffer to set up the environment, and usually use this command ./libraries/vendor/bin/phpcs --extensions=php -p --standard=libraries/vendor/joomla/cms-coding-standards/lib/Joomla-CMS . to apply the Joomla Specific Coding Standards.

particthistle commented 3 years ago

Leaving this here as a final task that will be run through with Joomla code maintainers.

There may be instances, particularly with JS calls, where there might be some subtle clean up and/or optimisation required.