EasyEngine/easyengine

Add phpcs rule to ensure one line is left empty after function declaration

Open

#1,222 opened on Sep 14, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)PHP (429 forks)batch import
good first issue

Repository metrics

Stars
 (1,984 stars)
PR merge metrics
 (Avg merge 20d 14h) (7 merged PRs in 30d)

Description

Currently PHPCS does not flag this as warning(which it should) -

function abc($a) {
    if($a){
        ...
    }
}

This is the coding the team has agreed to(and it should not display warning) -

function abc($a) {

    if($a){
        ...
    }
}

phpcs.xml needs to be modified in this and all the commands and site type repos.

Contributor guide

Research direction
Locate the phpcs.xml file in the repository and add a rule to enforce a blank line after function declarations. Refer to PHPCS documentation for the specific sniff (e.g., Squiz.WhiteSpace.FunctionSpacing).
Tech stack
php
Domain
backenddevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PHPPHPCS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90