WordPress / WordPress/WordPress-Coding-Standards
Wiki: document the metrics feature of the PrefixAllGlobals sniff
Open
Nobody has claimed this yet.
Status: Good first issue
Status: Help wanted
Type: Documentation
- Dominant language
- PHP
- Stars
- 2.8k
- Forks
- 521
- Avg merge
- 5d 20h
- Merged PRs (30d)
- 1
Description
PR #1437 added metrics to the PrefixAllGlobals sniff.
A wiki page should be added to document:
- How to go about fixing non-prefixed globals in a legacy project.
- How to use the new metrics feature in the sniff in aid of this (see the PR for a detailed example).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with PR #1437, especially its detailed example, and use the issue’s two requested topics to outline the wiki page: fixing non-prefixed globals in a legacy project and using PrefixAllGlobals metrics. Done means the wiki documents both workflows clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100