![\"npm](\"https://img.shields.io/npm/v/@rebilly/recomponents-next/latest.svg\")
View Documentation ![\"Revel\"](\"https://user-images.githubusercontent.com/1580169/211651583-03750a4c-71d9-4b2f-9af8-16d48b790e06.png\")
\n \n \n \n
\n \n View Documentation\n \n
\n\n\n\n## About this repo\nRevel is the design system used by designers and developers at Rebilly to build clean, elegant, and performant experiences for its merchants.\n\n## Commands\n### Install dependecies and start development\n```\nyarn && yarn docs:dev\n```\n\n### Commands\nCommand | Description\n-|-\n`dev` | Run the dev server for the component documentation. See `docs:dev`.\n`docs:dev` | Run the dev server for the component documentation.\n`docs:build` | Build component documentation as a static HTML site.\n`build` | Build the library.\n`build:watch` | Build the library and rebuild on file changes.\n`playground:dev` | Run the playground dev server (see [Playground](#playground)).\n`lint` | Run eslint.\n`lint:fix` | Run eslint and automatically fix issues.\n`test:unit` | Run the unit tests.\n`test:unit:watch` | Run the unit tests on changed files, in watch mode.\n\n### Playground\nSometimes it is easier to test a complex configuration directly in a vue application, rather than through our vuepress documentation.\n\nFor this, we provide a playground server which can be run with:\n```\nyarn playground:dev\n```\n\nNote: You must copy the playground component file \n`/src/playground/Playground-copyme.vue` to `Playground.vue`.\n\n## Contribution guide\n\nThis package is following the [Semantic Versioning](http://semver.org/) specification with [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and automated released with [Semantic Release](https://semantic-release.gitbook.io/semantic-release/).\n\nPull-requests are squashed into `main`, and by default the title of the PR becomes the commit message. For this reason, PR titles in this repository are linted against [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).\n\nTo create a feature, or fix an issue, create a PR into `main` with your fix, and ensure that the PR title follows Conventional Commits. Once approved, squash merging the PR into `main` will trigger Semantic Release, which will determine if a release is required based on the commit and if so automatically package and release the new version.\n\nThe following table shows examples of PR titles / `main` commit messages and the release they would trigger:\n| Commit/PR Title | Version |\n| - | -: |\n| perf(datepicker): ... | Patch release |\n| fix(datepicker): use margin of parent component in picker allocation | Patch release |\n| feat(datepicker): add option to specify picker vertical alignment | Feature release |\n| feat(datepicker)!: add option to specify picker vertical alignment | Breaking Release |\n| feat(datepicker): BREAKING CHANGE migrate from vuejs-datepicker to vue-date-picker | Breaking release |\n\nNote: Only commit types `fix`, `feat`, `perf` or breaking changes will trigger a release. Types such as `docs`, `chore`, `refactor` will not trigger a release.\n","readmeFilename":"README.md"}![\"semantic-release:](\"https://img.shields.io/badge/semantic--release-conventional%20commits-e10079?logo=semantic-release\"){kind=icon}
\n ![\"Release](\"https://github.com/Rebilly/revel/actions/workflows/release.yml/badge.svg\"){kind=icon}
\n