Skip to content

chore: state the package purpose in the composer description - #13

Merged
tyrsson merged 1 commit into
1.0.xfrom
chore/composer-description
Oct 17, 2026
Merged

tyrsson merged 1 commit into
1.0.xfrom
chore/composer-description

Conversation

@tyrsson

@tyrsson tyrsson commented Oct 17, 2026

Copy link
Copy Markdown
Member

What changed

webware-phpdb's composer.json description:

-"description": "PhpDb bridge for the Webware stack: shadows the PhpDb root namespace so packages can replace individual php-db/phpdb classes.",
+"description": "PhpDb bridge for the Webware stack.",

Why

The old text named an implementation tactic instead of the package's purpose. Read cold, "shadows the PhpDb root namespace" suggests the package overrides another library's namespace, which is a misleading claim to publish in package metadata. The description is now the single line of what the package is.

Verification

composer.json parses cleanly. No other hand-written copy of the phrase exists in the repository.

The phrase still appears in several composer.lock files across the fleet. Those are generated records of the installed package version and will pick up the new description on the next dependency refresh; they are not edited by hand.

The description named an implementation tactic ("shadows the PhpDb root
namespace") rather than what the package is for. Read cold, it suggests the
package overrides another library's namespace, which is not a claim this
package should be making in published metadata.

Description is now the one line of plain purpose.
@codecov

codecov Bot commented Oct 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@tyrsson
tyrsson merged commit fdd54ec into 1.0.x Oct 17, 2026
12 checks passed
@tyrsson
tyrsson deleted the chore/composer-description branch October 17, 2026 01:53
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