Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 1.88 KB

Contributing

Thanks for helping improve jooservices/wordpress-sdk.

Branch workflow

  • Start normal feature and fix work from the latest develop.
  • Open pull requests back into develop.
  • Use master only for release flow.
  • Do not merge pull requests until checks, approvals, and unresolved review threads are verified.

Setup

composer install

Validation

Run the relevant scripts before reporting completion:

composer validate --strict
composer lint
composer test
composer test:integration
composer security
composer quality
composer check
composer ci

Coding standards

  • Keep namespaces under JOOservices\*.
  • Preserve the current src/ architecture: Auth, Configs, Contracts, Data, Endpoints, Exceptions, Http, Pagination, Services, and Support.
  • Use jooservices/client for HTTP concerns.
  • Use jooservices/dto for DTO/data contracts.
  • Prefer typed services, DTOs, and query objects over magic service resolution.
  • Keep SDK core focused on the native WordPress REST API client, DTOs, auth, pagination, discovery/schema, errors, and generic REST payload helpers.
  • Do not add opinionated content templates, editorial workflows, or plugin/theme implementation logic to this package. Those belong in jooservices/wordpress-content-templates or consuming applications.
  • Pint is the formatting authority.

Tests and docs

  • Add or update tests for every public behavior change.
  • Keep docs, README, and maintenance notes current when behavior changes.
  • Normal tests must not require live WordPress network access.
  • Integration tests require WORDPRESS_URL, WORDPRESS_USER, and WORDPRESS_APP_PASSWORD.

Contributor and AI rule

Inspect the actual branch, source, tests, docs, CI, and package metadata before changing code. If requirements are unclear, conflicting, missing, or unverifiable from repository/source truth, stop and ask.