Dependencies demo/documentation #441
Closed
blackfalcon
started this conversation in
Improved tech suggestion
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Is your feature request related to a problem? Please describe.
When adding a new feature to an element or refactoring an existing element, there are visibility issues when it comes to other composite elements that have a dependency on the in dev. This causes issues where bugs are later found, or new features are needed, in dependent elements because of unintended side-effects of the work.
Describe the solution you'd like
To ensure that new work does not have an adverse effect on the dependents of the element in dev, the solution requested is to add a new demo page to the repo where dependent elements can be shown with the work in progress of the element in dev.
Ideas discussed were to pull in HTML demo content from other repos using Markdown Magic to render an easily maintainable demo page of the dependant elements with the work in dev.
Additionally, this will coincide with work being done with automated visual regression testing for each element.
Update to issue templates
When issues are refined, there needs to be a checklist option that asks if there are any clear dependents on the work in dev that need to be considered.
Stretch goal to further discuss
There is an idea that when we run
npm run test
we can pull in the test JS from any dependent element and it can run the additional tests with the new code in dev.There are concerns about if we can or need to run this in the cloud.
Exit criteria
This issue will be considered complete when the following items are addressed
Beta Was this translation helpful? Give feedback.
All reactions