doc(adrs): add theming peer dependency ADR-001 #1560
Conversation
Co-authored-by: George Treviranus <3946669+geotrev@users.noreply.github.com>
| ## Context | ||
|
|
||
| Garden provides a collection of React components through multiple NPM packages. | ||
| Each package has peerDependencies for `@zendeskgarden/react-theming`, `react`, |
There was a problem hiding this comment.
| Each package has peerDependencies for `@zendeskgarden/react-theming`, `react`, | |
| Each package has `peerDependencies` for `@zendeskgarden/react-theming`, `react`, |
#nit - if we are camel casing, should we wrap it as inline code?
| to ingest duplicated and more brittle code. A console warning will notify the | ||
| consumer if a peer version is out-of-date. |
There was a problem hiding this comment.
By console warning, do you mean in the terminal?
| consumer if a peer version is out-of-date. | ||
|
|
||
| Ideally, all Garden package versions should align. However, at the very least, | ||
| the theming peer dependency should align with the highest version of a Garden |
There was a problem hiding this comment.
| the theming peer dependency should align with the highest version of a Garden | |
| the `@zendeskgarden/react-theming` peer dependency should be kept in sync to the latest version. |
Suggestion -> Being literal about "theming peer dependency" to remove any room for interpretation, the same with "highest version".
There was a problem hiding this comment.
...kept in sync to the latest version
is not technically accurate for what we are asking of the consumer. For example, when Garden v9 lands, we are not necessarily asking the consumer to make sure the theming package is v9. Rather, this ADR is specifying that theming should be in sync with whatever highest version of Garden package the consumer has installed – and, technically, must be up-to-date with whatever highest peer dependency any given Garden package calls for.
There was a problem hiding this comment.
Okay I understand now and fair point.
| treatment for `@zendeskgarden/react-theming`. | ||
|
|
||
| While this decision conflicts with [semantic versioning](https://semver.org/), | ||
| it benefits both maintainers and consumers by enabling centralized and tested |
There was a problem hiding this comment.
| it benefits both maintainers and consumers by enabling centralized and tested | |
| it benefits both maintainers and consumers by enabling a centralized, tested collection of hooks and utilities across the codebase. |
Suggestion -> The sentence was hard to read..
Description
Brings the decision made 2023.04.24 re: the
@zendeskgarden/react-themingpeer dependency into GitHub, along with a README for indexing future ADRs.