Skip to content

Adopt the family conventions - #1

Merged
imanimanyara merged 1 commit into
mainfrom
chore/adopt-family-conventions
Aug 27, 2026
Merged

Adopt the family conventions#1
imanimanyara merged 1 commit into
mainfrom
chore/adopt-family-conventions

Conversation

@imanimanyara

Copy link
Copy Markdown
Member

Among the oldest things in the org — last touched 2023 — with the correct vendor and Providers/
layout and almost nothing else: no tests, no CI, no LICENSE, no docs/, PHP >=8.0, and a
default branch of master.

Public names

The config key and view namespace were the bare slug. Laravel keeps both in flat global maps,
so a second package claiming one replaces this silently, surfacing elsewhere as a missing view or the
wrong config value.

The publish tags were already vendor-scoped, which is what made the gap easy to miss by eye: two
of the four names were right.

Surface Was Now
Config key git-commit-checker laranail.git-commit-checker
View namespace git-commit-checker laranail/git-commit-checker
Publish tags laranail::git-commit-checker-* unchanged

Views take the slash form because Laravel interpolates the namespace into the override path, so an
override now lands in resources/views/vendor/laranail/git-commit-checker.

Dependencies

  • PHP >=8.0^8.4.1 || ^8.5, the family floor.
  • laravel/framework → the individual illuminate/* components actually used. A package should
    not require the whole framework.
  • laravel/pint out of require, where it forced a dev tool into every consuming application.

Added

A test suite and CI (SHA-pinned per the org standard), a LICENSE, a docs/ tree, and a
branch-alias.

The naming test reads the live registriesView::getFinder()->getHints() and the config
repository — not the provider source, so it survives a refactor of the registration code.

Also done outside this diff

master was renamed to main, per the org branch convention.

Breaking

Anyone reading config('git-commit-checker.…') or view('git-commit-checker::…') must move to the scoped names.

This package predates them. It was the oldest thing in the org -- last
touched 2023 -- with correct vendor and Providers/ layout and almost
nothing else.

PUBLIC NAMES. The config key and view namespace were the bare slug.
Laravel keeps both in flat global maps, so a second package claiming one
replaces this silently and the failure surfaces elsewhere as a missing
view. The publish tags were already vendor-scoped, which is what made
the gap easy to miss by eye: two of the four names were right.

DEPENDENCIES. PHP >=8.0 becomes the family floor ^8.4.1 || ^8.5.
laravel/framework becomes the individual illuminate/* components
actually used -- a package should not require the whole framework. And
laravel/pint moves out of require, where it was forcing a dev tool into
every consuming application.

Adds the test suite and CI this had none of, a LICENSE, and a docs tree.
The naming test reads the LIVE registries -- View::getFinder()
->getHints() and the config repository -- rather than grepping the
provider, so it survives a refactor of the registration code.
@imanimanyara
imanimanyara merged commit 0594f26 into main Aug 27, 2026
6 checks passed
@imanimanyara
imanimanyara deleted the chore/adopt-family-conventions branch August 27, 2026 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant