@commversion/libs 0.2.0-4 → 0.2.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 +18 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,6 +23,15 @@ Configuration takes place by global `window.commversion` object, make sure to no
|
|
|
23
23
|
</script>
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
+
## Available scripts
|
|
27
|
+
|
|
28
|
+
All scripts are available under the `packages/` directory.
|
|
29
|
+
|
|
30
|
+
- lc-exit-intent
|
|
31
|
+
- lc-ga-tags
|
|
32
|
+
- lc-input-errors
|
|
33
|
+
- schedule-event
|
|
34
|
+
|
|
26
35
|
## Release new versions
|
|
27
36
|
|
|
28
37
|
The project follows the semantic versioning convention.
|
|
@@ -31,11 +40,16 @@ Patch releases for bug fixes.
|
|
|
31
40
|
Minor releases for new features.
|
|
32
41
|
Major releases for breaking changes.
|
|
33
42
|
|
|
34
|
-
The release is fully automated by executing `npm run release`.
|
|
43
|
+
The release is fully automated by executing `npm run release`. No need to run build scripts beforehand, this is done automatically.
|
|
35
44
|
|
|
36
45
|
## Guideline for contributing
|
|
37
46
|
|
|
38
|
-
|
|
39
|
-
|
|
47
|
+
Add a new script in a directory under the `packages/` one.
|
|
48
|
+
|
|
49
|
+
To include it in the final build, the following are needed:
|
|
50
|
+
|
|
51
|
+
- A build and dev entry in `package.json`.
|
|
52
|
+
- A `vite.config.js` inside the package (mind the filenames configured there)
|
|
53
|
+
- Unit tests under the `package/tests` directory.
|
|
40
54
|
|
|
41
|
-
|
|
55
|
+
Start working on a specific script by running `npm run package:dev`.
|