Skip to content
This repository has been archived by the owner on Nov 17, 2021. It is now read-only.

o-toggle complete breaking checklist #25

Closed
10 tasks done
notlee opened this issue Aug 29, 2019 · 1 comment
Closed
10 tasks done

o-toggle complete breaking checklist #25

notlee opened this issue Aug 29, 2019 · 1 comment
Labels
breaking Will require a major version bump

Comments

@notlee
Copy link
Contributor

notlee commented Aug 29, 2019

Origami plan to release major new versions of low level components, which remove technical debt from recent additions such as component branding, and implement more recent proposals such as adding a primary Sass mixin and removing custom classes from many Sass interfaces.

steps

  • Add MIGRATION.md
  • Add a primary mixin, removing other mixins where possible.
  • If a mixin is required which does not output a selector, e.g. for component composition, create an oComponentContent mixin with options like the primary mixin (Content infers the mixin does not output selectors).
  • Replace methods to customise a component's style globally with a mixin oComponentCustomise e.g. so a whitelabel user can customise the style of a primary o-buttons button.
  • Replace mixins which add new variations of a component with an oComponentAddSomething mixin e.g. so a user may output a new o-buttons button, alongside primary buttons etc.
  • Remove custom classnames.
  • Use the $system-code variable for the source param in image service requests, error if not found, update obt to ^ 8.2.2 locally and in circleci config.
  • Remove existing semver ranges e.g. for o-brand and o-icons "o-brand": ">=2.2.0 <4",. We can't add new features to components used with a semver range without back-porting.
  • Use esm consistently over cjs module syntax.
  • Solve existing issues labeled "breaking" if possible.
@notlee
Copy link
Contributor Author

notlee commented Sep 2, 2019

Closing this to keep track of progress. The PR can be found here: #27. It will be released as part of the major cascade.

@notlee notlee closed this as completed Sep 2, 2019
Origami Major Cascade automation moved this from In Progress to Done Sep 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
breaking Will require a major version bump
Projects
No open projects
Development

No branches or pull requests

1 participant