🔓Keeping the lock file in sync

These instructions will help to ensure we don't introduce unwanted changes to the lock file.

Since we use some private modules alongside the public monorepo, we have some special requirements when dealing with lock file changes. This can be confusing for some contributors and there's some discussion around it as well.

The rule of thumb is: As long a we don't introduce new packages (either in a package.json or monorepo package) there shouldn't be any lock file changes in a core contributor local environment.

For core-contributors, how to ensure a consistent setup for submodules

  • Make sure you're on main

    git checkout main
  • Make sure you have private submodules initialized and updated

    ./git-setup.sh website console
  • Run yarn install to see if there are lock file diffs


For external contributors

Please refer to the "Guidelines for committing yarn lock file" section in our CONTRIBUTING.md guide.

Last updated