Contribute

All contributions are welcome! Please create an issue for bugs and feature requests, and use pull requests for code contributions.

Project Setup

Build artifacts are tracked in the repository until we create a dedicated distribution repository that can be used for storing the Composer packages.
We use wp-env for local development environment. See all the env:* scripts in package.json for supported commands and helpers.
webpack.config.js configures how @wordpress/scripts transforms JS and CSS assets during packaging.
We use the @wordpress/eslint-plugin/recommended-with-formatting ruleset for JS linting since the Prettier integration is currently unreliable in @wordpress/scripts.

See the scripts section in package.json for the list of all the available scripts.

Confirm that the latest build artifacts for JS and CSS are up-to-date and tracked in the repository by running npm run build and confirming that git doesn't see any changes.
Create a new pull request to master for the release specific changes that increment the plugin version and add the release changelog to the README.
Follow the Release Checklist in the pull request template when preparing the release.
Use semantic versioning.
After merging the release pull request, create a new tag from the master branch using the latest plugin version string as the tag name.
Copy the latest changelog from README to the release notes.