loadsys / loadsys/loadsys_codesniffer

Review "failing" sample files for multiple failures, split into separate files.

Open
#45 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help-wanted
Dominant language
PHP
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Some of the sample files currently fail multiple sniffs. Our testing harness can catch multiple sniff failures per file, but it makes the tests relatively inflexible since the files aren't "atomic" compared to the sniff rules.

It's also possible for the test files to be failing tests they really shouldn't be, such as overlapping rules that cover the same "problem" with the code. In these cases, the ruleset needs to be modified to try to only include one relevant rule to cover the failure.

Bottom line is: The files in `snifftests/files` that contain first lines like this:

``` php

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the files in snifftests/files whose first lines list multiple failing rules. Check whether each failure is distinct; split files where possible, or review the CakePHP and PSR-2 ruleset overlap where failures cover the same problem. Done means the affected samples have atomic failures or an adjusted ruleset.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.