Skip to content

Commit 83576a2

Browse files
authored
docs(contributing): provide visual changes background (#11264)
**Related Issue:** #10967 ## Summary Include a `Visual changes` section to supplement the `Visual snapshots` section within the CONTRIBUTING.md.
1 parent 539fb2b commit 83576a2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

CONTRIBUTING.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ Calcite follows [Conventional Commits](https://www.conventionalcommits.org/en/v1
219219
Contributions should adhere to the `<type>(<scope>): <descriptive summary>` format and include the following:
220220

221221
- [Commit type](#commit-type)
222-
- [Scope of change](#scope-of-change), *optional*
222+
- [Scope of change](#scope-of-change), _optional_
223223
- [Descriptive commit subject](#descriptive-commit-subject)
224224

225225
Check out the [contribution example](#contribution-example) for a formatted example, and explore [breaking change formatting](#breaking-changes) for consideration during Calcite's breaking change releases.
@@ -240,7 +240,7 @@ Contributions must adhere to **one** of the following types:
240240

241241
### Scope of change
242242

243-
*Optional*. Most contributions will include a scope, such as a component, multiple components, test(s), or utilities. For example:
243+
_Optional_. Most contributions will include a scope, such as a component, multiple components, test(s), or utilities. For example:
244244

245245
- `text-area`
246246
- `dropdown, dropdown-group, dropdown-item`
@@ -328,6 +328,12 @@ By default, the PR body will be used for the commit message when squash merging,
328328

329329
### Visual snapshots
330330

331-
If the PR includes visual changes, once you are ready to run Chromatic to create visual snapshots, add the `pr ready for visual snapshots` label to the PR. Removing and re-adding the label is required to re-run snapshots, e.g. when pushing additional updates.
331+
If the PR's linked issue contains the `visual changes` label **or** the PR contains [visual changes](#visual-changes), once you are ready to run Chromatic to create visual snapshots, add the `pr ready for visual snapshots` label to the PR. Removing and re-adding the label is required to re-run snapshots, e.g. when pushing additional updates.
332332

333333
If visual snapshots are not necessary for the PR (e.g. changes to doc, ci, storybook, etc.), you can add the `skip visual snapshots` label instead. The `skip visual snapshots` label can also be used to prevent re-running Chromatic after pushing minor cleanup changes before merging.
334+
335+
#### Visual changes
336+
337+
Visual changes include issues and/or PR's that introduce a visual alteration that is not backwards compatible. If the change could prevent a visual test from passing, the change should be considered a visual change. Visual changes should be coordinated with designers and have consistency across the design system in mind.
338+
339+
Visual changes can be a standalone change, or be introduced with breaking changes. For instance, [Split button consistent divider across appearances](https://github.com/Esri/calcite-design-system/issues/8142) and [List scales, padding, spacing, and font sizes](https://github.com/Esri/calcite-design-system/issues/7100).

0 commit comments

Comments
 (0)