alleyinteractive / alleyinteractive/alley-scripts

SlotFill entrypoint template comment causes issue with common PHPCS rule

Open
#684 0 comments 0 reactions 0 assignees View on GitHub
bug good first issue
Dominant language
TypeScript
Stars
10
Forks
3
Avg merge
4d 22h
Merged PRs (30d)
2

Description

### 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_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.