Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deprecate (add warnings) to any scss code that has been duplicated into deprecated-component-library-helpers #1010

Closed
4 tasks
mbylstra opened this issue Feb 8, 2021 · 1 comment
Assignees

Comments

@mbylstra
Copy link
Contributor

mbylstra commented Feb 8, 2021

There is currently a lot of duplicated code in https://github.com/cultureamp/kaizen-design-system/tree/master/packages/deprecated-component-library-helpers/styles and https://github.com/cultureamp/kaizen-design-system/tree/master/packages/component-library/styles.

This makes it very hard for contributers to know which ones to update (one, the other, or both?). Let's try to add deprecation warnings as suggested in #701 to make this problem more noticeable.

TODO:

  • work out exactly which variables and mixins in the component-library are deprecated. The ones that are duplicated in deprecated-component-library-helpers are 100% deprecated, but the ones that are it's less clear. Pretty much all of the component-library/styles is deprecated in the sense that it's not the way we want to do things going forward, but they the maybe still useful and widely used without a better alternative yet (so not really deprecated yet)
  • figure out an effective way (as suggested in Handling deprecation in Kaizen #701)
  • add comments to the top of both files about whether the corresponding duplicate code needs to be updated (yes it does)

Stretch goal (split into new card issue if not done):

  • see if there are any differences between sass code in component-library/styles and deprecated-component-library-helpers (using diff program). If there are, then "the conflicts" need to be "resolved" (this is the big problem with having duplicated code!) as we can't easily be sure which repos are using the older code (which might have drifted out of sync.

Once this is done, we want to also tackle #1012 (this is just a stepping stone)

@mbylstra mbylstra changed the title deprecate or removeany scss code that has been duplicated into deprecated-component-library-helpers deprecate (add warnings) to any scss code that has been duplicated into deprecated-component-library-helpers Feb 8, 2021
@mbylstra mbylstra self-assigned this Feb 15, 2021
@mbylstra
Copy link
Contributor Author

Done in #1046

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant