Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.34 KB

Contributing

This guide describes how you can successfully contribute to our design system "Atomic Playfulness".

Preparing Your Workspace

  • Ensure you have the latest version of Node.js and npm installed.
  • If you use a Node.js version manager that supports .node-version files, you can install the specific Node.js version from the repository's .node-version file.
  • Install all workspace dependencies and Git-hooks with: npm i

Git Workflow

Our workflow centers around feature branches. Every change to the project must be done through a pull request. Inside a PR branch, feel free to make as many commits as necessary.

For commit messages, we follow the Conventional Commits naming convention. Consider this a best practice for feature branches. For commits on main it is a requirement.

As we use the "Squash and Merge" strategy to combine the PR into a single commit on our main branch, the PR title must be a conventional commit message.

Versioning

We use semantic versioning.

To track versions and changelogs, we use changesets. In order to include your changes into the versioning and changlogs, run

npx changeset

to create a new changelog entry and version increment.