@indico-data/design-system 2.0.2 → 2.0.3
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 +52 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,6 +21,58 @@ Run the below like `yarn <my command>`
|
|
|
21
21
|
"prepare": "husky install"
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
+
## Commit Hygiene
|
|
25
|
+
|
|
26
|
+
This repository follows the [Angular Commit Message Format](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format). This repository uses the PR title and description to configure the contents of the commit message of the squashed commit associated with the PR: In general, a PR should use the following structure:
|
|
27
|
+
|
|
28
|
+
### Title
|
|
29
|
+
|
|
30
|
+
Should have the following format: `<type>(<scope | ticket id>): <short summary>`
|
|
31
|
+
|
|
32
|
+
- `<type>` should be `fix`, `feat`, `perf` for controlling releases
|
|
33
|
+
|
|
34
|
+
Examples:
|
|
35
|
+
|
|
36
|
+
- `fix(SNC-221): cleanup README`
|
|
37
|
+
- `feat(SNC-222): add dark mode`
|
|
38
|
+
- `perf(SNC-223): improve canvas performance`
|
|
39
|
+
|
|
40
|
+
### Description
|
|
41
|
+
|
|
42
|
+
Format:
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
<General Description of PR Changes>
|
|
46
|
+
<Empty Line>
|
|
47
|
+
<Footer>
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The footer should start with `BREAKING CHANGE:` to initiate a major release.
|
|
51
|
+
|
|
52
|
+
Example:
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
This PR includes major changes to the button component.
|
|
56
|
+
|
|
57
|
+
BREAKING CHANGE: Replaced button component.
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
See below for more information on how commit structure affects releases.
|
|
63
|
+
|
|
64
|
+
## Releasing
|
|
65
|
+
|
|
66
|
+
### Automatic Releases
|
|
67
|
+
|
|
68
|
+
This repository uses [Semantic Release](https://github.com/semantic-release/semantic-release) to control versioning and releases. To release a new version as part of a pull request, use a [semantic commit message](https://github.com/semantic-release/semantic-release?tab=readme-ov-file#commit-message-format) (prefixes like `fix` `feat`, `perf`, or `BREAKING CHANGE` in the footer) in the title and description of your pull request.
|
|
69
|
+
|
|
70
|
+
You also need not update the version number in `package.json`, since [Semantic Release controls the npm release process entirely by way of managed Git tags](https://semantic-release.gitbook.io/semantic-release/support/faq#why-is-the-package.jsons-version-not-updated-in-my-repository).
|
|
71
|
+
|
|
72
|
+
### Manual Releases
|
|
73
|
+
|
|
74
|
+
Do not manually release Permafrost, as it may cause issues with the Semantic Release pipeline.
|
|
75
|
+
|
|
24
76
|
## Theming Addon Documentation
|
|
25
77
|
|
|
26
78
|
### Addon - Themes
|