alleyinteractive / alleyinteractive/alley-scripts

SlotFill entrypoint template comment causes issue with common PHPCS rule

Aperta
#684 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
bug good first issue
Lingua principale
TypeScript
Stelle
10
Fork
3
Merge medio
4g 22h
PR unite (30g)
2

Descrizione

### Description of the bug

Following the basic setup steps for `npm run create-slotfill` will create a PHPCS violation against a commonly used rule: `Generic.Commenting.DocComment.ShortNotCapital`. A simple fix here could be to simply change the comment text.

See: https://github.com/alleyinteractive/alley-scripts/blob/main/packages/create-entry/templates/slotfill/index.php.mustache#L4

### Steps To Reproduce

1. `npm run create-slotfill`
2. name the slotfill slug anything starting with a lower-case letter
3. follow the rest of the setup prompts and create the slotfill files.
4. run PHPCS the generated PHP file in `/entries//index.php` (the ruleset must include `Generic.Commenting.DocComment.ShortNotCapital`)

### Additional Information

_No response_

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.