CONTRIBUTING.md

How to Contribute

Using devcontainers

If you are using devcontainers and/or codespaces then you can start contributing immediately and skip the next step.

Formatting

Starlark files should be formatted by buildifier. We suggest using a pre-commit hook to automate this. First install pre-commit, then run

pre-commit install

Otherwise later tooling on CI will yell at you about formatting/linting violations.

Updating BUILD files

Some targets are generated from sources. Currently this is just the bzl_library targets. Run bazel run //:gazelle to keep them up-to-date.

Using this as a development dependency of other rules

You'll commonly find that you develop in another WORKSPACE, such as some other ruleset that depends on rules_formatjs, or in a nested WORKSPACE in the integration_tests folder.

To always tell Bazel to use this directory rather than some release artifact or a version fetched from the internet, run this from this directory:

OVERRIDE="--override_repository=rules_formatjs=$(pwd)"
echo "common $OVERRIDE" >> ~/.bazelrc

This means that any usage of @rules_formatjs on your system will point to this folder.

Releasing

Release Please opens or updates a version bump PR from Conventional Commits. Merging that PR creates the tag and GitHub release, then builds release assets, creates attestations, and opens the Bazel Central Registry PR automatically.

Do not choose or push a tag manually. See docs/releasing.md for setup, checks, monitoring, and recovery.