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

Reorganize contracts for better discoverability and clarity #2527

Closed
frangio opened this issue Feb 17, 2021 · 0 comments · Fixed by #2503
Closed

Reorganize contracts for better discoverability and clarity #2527

frangio opened this issue Feb 17, 2021 · 0 comments · Fixed by #2503
Labels
breaking change Changes that break backwards compatibility of the public API.

Comments

@frangio
Copy link
Contributor

frangio commented Feb 17, 2021

We've identified that users are not always aware of all of the contracts that we offer, and that it can be difficult to find the things they want.

To improve this situation we want to reorganize the contracts so that they can be more easily discoverable, and that the directory structure is clearer and more useful to find a specific contract.

The specific of this reorganization will be discussed in the corresponding PR.

Since this is a breaking change due to files moving around, we've evaluated some alternatives to either make this change backwards compatible or to mitigate the pain it will cause to upgrade. One option was to include files with import statements to redirect the previous import paths to the new ones, but this would have the undesirable consequence of polluting the repository or the npm package with many (pseudo-)duplicate files that would hinder the discoverability improvements we set out to make. In the end we've decided to ship a small script that can be used when upgrading to adjust import statements to their new paths.

@frangio frangio added the breaking change Changes that break backwards compatibility of the public API. label Feb 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Changes that break backwards compatibility of the public API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant