@justeat/pie-design-tokens

pie-design-tokens

Pie Design Tokens repo – our JET global design token package.

---

How to contribute:

Pre-flight

Setup environment:

• yarn @ ^1.0.0
• node @ ^16.0.0

Install the project:

yarn install

Build the project:

yarn build

If you need to add, change or remove tokens the changes should be done in pie-design-tokens.jsonc file, where all the tokens are stored. To verify that the changes took effect, build the project and check the compiled files in the dist folder.

Each change needs to be accompanied by manual changelog entry in CHANGELOG.md and package version bump in package.json. The package follows semantic versioning.

Each change should also be replicated in metadata/tokensMetadata.json file.

yarn test and yarn test:output -u have to be run to verify any update.

If your change touches the tokens structure, compile scripts in the build folder might need to be updated to make sure that the tokens are compiled as expected.

Pull requests

When raising a merge request in the pie-design-tokens repo, please follow these guidelines.

PR title

PR titles should start with the package version number. To mark the ticket as wip, please raise it as a Draft PR on Github.

PR Descriptions

You can copy the changelog entry into the PR description.

Things to do before requesting PR reviews

• Make sure that the build ran successfully and all the PR checks passed.
• Add all the details for your change to the PR description and Changelog. Use previous PRs in the repo as an example.