@ambita/design-system 5.5.1 → 5.5.2-1971.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -37,6 +37,13 @@ Post-merge, another workflow will be run, publishing a @latest package to npm wh
37
37
  npm i @ambita/design-system
38
38
  ```
39
39
 
40
+ #### How to merge branches
41
+
42
+ **IMPORTANT!** Branches merged to `dev` can be squash merged for a prettier history tree, but DON'T squash merge `dev` to `main`.
43
+ Instead, chose "Create a merge commit".
44
+
45
+ <img alt="create a merge commit in GitHub" src="docs/merge-commit.png" width="400">
46
+
40
47
  #### New Components
41
48
 
42
49
  Every new component and helper should have a storybook document associated with it and preferably unit tests as well. Remember to export it in `./src/index.ts`.