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

Patterns / Resuable Blocks and the technical debt #57530

Open
talldan opened this issue Jan 4, 2024 · 0 comments
Open

Patterns / Resuable Blocks and the technical debt #57530

talldan opened this issue Jan 4, 2024 · 0 comments
Labels
[Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Type] Code Quality Issues or PRs that relate to code quality

Comments

@talldan
Copy link
Contributor

talldan commented Jan 4, 2024

What problem does this address?

After the rename of Reusable Blocks to Patterns in the UI, there's now quite a bit of technical debt in the codebase.

Some newer features have adopted the 'Patterns' naming within code, while older features still use the 'Reusable Blocks' terminology.

This includes:

  • A 'reusable blocks' package, which coexists alongside a 'patterns' package.
  • Comments across the codebase referring to the feature as reusable blocks.
  • Private and public APIs using the Reusable Blocks naming.

What is your proposed solution?

Private APIs can be renamed.

I think it's worth assessing on a case-by-case basis whether public APIs should be deprecated/renamed to patterns. Or alternatively there may be betters way to achieve what the API does.

In some cases, like the 'reusable blocks' package, it's continued existence might be confusing for developers. That package also seems to have some unused functionality (the redux store), and other than that it only exports one component, so it might be a good option to move functionality over to the patterns package and deprecate the package.

@talldan talldan added [Type] Code Quality Issues or PRs that relate to code quality [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced labels Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

No branches or pull requests

1 participant