Contributing

Contributions are welcome, from bug reports and documentation fixes to translations and code changes.

Before writing code

Search existing issues, then open or join an issue to describe the problem, expected behavior and proposed direction. This avoids parallel work and makes review easier.

Read the complete upstream contribution guide before setting up the repository. It remains authoritative for exact commands, supported tool versions and generated files.

Work from source-owned documentation

• Edit fragments in readme/, then rebuild README.md and README.txt; do not edit those generated outputs directly.
• Update hook comments at their PHP dispatch sites, regenerate hook-docs/hooks-inventory.json, then regenerate the prose reference.
• Capture new product screens with the repository tool, review them and deliberately promote selected images into assets/en_US.
• Keep standalone integration examples inside examples/, with installation and manual verification notes.

These rules prevent the website, WordPress.org listing and repository documentation from drifting apart.

Validate the affected layer

Run the automated tests, static checks and build commands that cover your change. When behavior is visible in WordPress, also record the manual path you tested. Changes to a hook contract require regenerated hook documentation; readme changes require the generated outputs to be current.

Prepare a pull request

• Keep the change focused and explain why it is needed.
• Follow the existing code style and project structure.
• Add or update tests when behavior changes.
• Update user or developer documentation in the same change.
• Describe manual verification steps and relevant WordPress, PHP and browser versions.
• Mention generated files and source fragments together so reviewers can trace the change.

Project links

Browse issues, review open pull requests, inspect the working examples or consult the hook reference.