J3 Issue ? ?
avatar mbabker
mbabker
17 Jan 2018

Right now we have the base coding standards which are meant to be our coding standards used for all projects and a recommendation for extension developers to follow. That repository, while it covers our general standards fairly well, can't have application specific rules in it like ones that apply to the CMS environment only (this is generally where you get into things like formatting of layout files or proposals such as the deprecated code sniffs). Additionally, since the CMS ruleset lives in this repository, to run code style checks with the CMS specific rules in place you have to clone this repository (which complicates setting up other tooling), whereas with our base coding standards repo all you need is a composer install and it is fairly easy to set up checks in CI environments.

I'd like to suggest moving the CMS coding standards to a new repository so that the extended ruleset can be used more easily outside of the CMS repository with the ruleset inheriting from the base standards repo so that we aren't duplicating maintenance efforts (for years the coding standards repo has lived separately from the ruleset inlined into this repo and they have diverged in some ways, plus some fixes have been made in one place but not the other), and this also makes the CMS ruleset available for use in other projects (right now in com_patchtester I run PHPCS against the main coding standards repo but have to have some extra rules/excludes that are already covered by the CMS ruleset for its layout files).

avatar mbabker mbabker - open - 17 Jan 2018
avatar joomla-cms-bot joomla-cms-bot - change - 17 Jan 2018
Labels Added: ?
avatar joomla-cms-bot joomla-cms-bot - labeled - 17 Jan 2018
avatar mbabker mbabker - change - 17 Jan 2018
Labels Added: ?
avatar mbabker mbabker - labeled - 17 Jan 2018
avatar brianteeman
brianteeman - comment - 17 Jan 2018

Seems to make logical sense to me

avatar franz-wohlkoenig franz-wohlkoenig - change - 17 Jan 2018
Status New Discussion
avatar franz-wohlkoenig franz-wohlkoenig - change - 17 Jan 2018
Category Code style
avatar nibra
nibra - comment - 18 Jan 2018

+1 - makes absolutely sense.

avatar tonypartridge
tonypartridge - comment - 18 Jan 2018

+1 from me too! Great idea.

avatar brianteeman brianteeman - change - 25 Mar 2018
Labels Added: J3 Issue
avatar brianteeman brianteeman - labeled - 25 Mar 2018
avatar roland-d
roland-d - comment - 2 Apr 2018

+1 Sounds good.

avatar laoneo
laoneo - comment - 2 Apr 2018

+1

avatar yvesh
yvesh - comment - 2 Apr 2018

+1

avatar dgt41
dgt41 - comment - 2 Apr 2018

+1

avatar mbabker
mbabker - comment - 3 Apr 2018

Repo built - https://github.com/joomla/cms-coding-standards

Here's hoping it's a maintained resource and doesn't become abandonware.

avatar mbabker mbabker - change - 3 Apr 2018
Status Discussion Closed
Closed_Date 0000-00-00 00:00:00 2018-04-03 12:09:57
Closed_By mbabker
avatar mbabker mbabker - close - 3 Apr 2018

Add a Comment

Login with GitHub to post a comment