Contributing

Sending a pull request#

1. Clone the repository: git clone https://github.com/Getsoren/design-system.git
2. Update your local master: git checkout master && git pull upstream master
3. Install dependencies: yarn install
4. Create a branch: git checkout -b my-branch-name
5. Commit your changes, push your branch, and open a pull request

See local development for the scripts you'll use while working (yarn run dev, yarn run build, yarn run preview).

Conventions#

Contributions are expected to follow:

• Airbnb JavaScript Style Guide for code style
• Semantic Versioning for version numbers
• Conventional Commits for commit messages

Before you open a PR#

Make sure your changes pass the existing test suite — see testing — and that Storybook still renders correctly for any component you touched, see Storybook.

← Back: Testing · Next: Tech stack →