Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (19 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.71 KB
Raw

Contributing

Changelog entries

Each package maintains its own CHANGELOG.md in Keep-a-Changelog format. To avoid merge conflicts when multiple PRs touch the same package, entries are added as fragment files in packages/<name>/changelog/ and aggregated into a release block by automattic/jetpack-changelogger.

For a PR touching a specific package, use the matching script:

composer packages:bootstrap:changelog:add        # wp-framework-bootstrap
composer packages:core:changelog:add             # wp-framework-core
composer packages:infrastructure:changelog:add   # wp-framework-infrastructure
composer packages:shared:changelog:add           # wp-framework-shared
composer packages:woocommerce:changelog:add      # wp-framework-woocommerce

The interactive prompt asks for Significance (patch/minor/major) and Type (added/changed/deprecated/removed/fixed/security). Commit the fragment file with the rest of the PR. CI validates every fragment via composer changelog:validate.

Releases

Per package:

composer packages:bootstrap:changelog:write   # swap "bootstrap" for core / infrastructure / shared / woocommerce

Aggregates packages/<name>/changelog/* → new version block in packages/<name>/CHANGELOG.md, computes the next semver from fragment significance levels, deletes the fragments. Commit the diff. The split-packages workflow propagates the package (with its updated CHANGELOG.md) into the per-package consumer-facing repo on push to trunk.

The seed ## 2.0.0 - unreleased block in each package's CHANGELOG.md is jetpack-changelogger's native unreleased-date placeholder. New release blocks get inserted above it.