Contributing setup
Planning to contribute to EDS, Icons or Shared Widgets? This guide helps you setup the aw-frontend-monorepo
.
Prerequisites
Using corepack is suggested to manage your pnpm version. Otherwise make sure that you are using the node
and pnpm
versions listed under the engines
key in the root package.json
file.
Installation
pnpm install
Build all packages and apps
pnpm build
View runnable scripts
pnpm run
Versioning and publishing packages
When creating or making changes to your component, make sure you include a changeset.
A changeset is a file that describes the changes that have been made to your component, and is required for versioning and publishing your component.
A changeset includes:
- What version change this is: major, minor or patch. Make sure you follow semver when determining what type of change to make.
- Release notes for this change.
You can create a changeset by running the command pnpm changeset
in the monorepo root - this will start the stepped process in creating your changeset.
Please review their documentation to familiarise yourself with the workflow.