Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.61 KB
Raw

Contributing

Thanks for showing interest in contributing to Einride UI!

Suggesting Features

Before creating a PR, consider that Einride UI is an implementation of Einride's design system. It has no design opinions in itself – the goal is merely to reflect the design system as close as possible.

If you have ideas on how to improve design and functionality, please use GitHub Discussions.

Developer experience (DX) is an area where Einride UI has opinions. If you have ideas on how to improve DX, please use GitHub Discussions conveying your idea, or create a PR following the Pull Request Guidelines.

Reporting Issues

If you find a bug, please create an issue for it, or create a PR following the Pull Request Guidelines.

Development

Follow these steps to start development server:

  • Install dependencies by running yarn.
  • Create an local env file .evn.local based on .env.example and fill in missing env values.
  • Start Storybook by running yarn storybook.

Pull Request Guidelines

Einride UI is using the Conventional Commits commit message convention.

Every component should come with a component file [Component].tsx, a Storybook file [Component].stories.tsx and a documentation file [Component].mdx.

Follow the conventions provided in STYLE.

Before opening a PR, please make sure you get no errors when running yarn review.