| id | name | file_version | app_version | file_blobs | ||
|---|---|---|---|---|---|---|
o175v |
Development Workflow |
1.0.2 |
0.9.0-2 |
|
Run yarn install to install dependencies.
Run yarn dev to open Vuepress, the documentation platform we use to create a catalog of the components, as well as the design tokens (fonts, colors, spacings etc).
To change an existing component, open it's .md files inside 📄 docs/components and edit the file.
When creating a new component, create a new .md inside 📄 docs/components and add examples for all the possible variants of the component (see below).
Make sure to document the possible variants of a component, or any design token, using the correct markdown file inside the 📄 docs folder. Using the ::: demo markdown container, you can easily create a live example of the component, while showing the code snippet you used for that example:
🟩 13 ## Primary
🟩 14
🟩 15 ::: demo
🟩 16 <Action>Primary Default</Action>
🟩 17 :::You can also add a description for the component, or any other relevant information.
We use Vitest and Vue Test Utils for component and unit testing. Make sure to cover your changes with tests.
To run all test, run yarn test
IMPORTANT: Before committing your changes, make sure to read this: Release Workflow.
To commit your changes you can run yarn commit and follow the wizard, or alternatively write a commit in the Conventional Commits format. Pay attention to the type of the commit as it will or will not trigger a new version release.
You can also use the VS Code extension or IntelliJ
Read more about Conventional commits and the automated release in Release Workflow.
If a new version is triggered, the release workflow will run in GitHub Action. When it's finished, Semantic Release will add a message to the PR/s who are included in this release:
Also, the 📄 CHANGELOG.md will be updated and the new version will be updated in [[sym:././package.json(e626242b-9dd2-4b03-b376-44dfc8601094)]].
Read more about using the library in Using The Library.
This file was generated by Swimm. Click here to view it in the app.