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

feat: ✨ add testing and tracking attributes to components #1059

Open
9 tasks
karlbaumhauer opened this issue May 8, 2024 · 2 comments
Open
9 tasks

feat: ✨ add testing and tracking attributes to components #1059

karlbaumhauer opened this issue May 8, 2024 · 2 comments
Assignees
Labels
🔧 code needs changes in code

Comments

@karlbaumhauer
Copy link
Contributor

karlbaumhauer commented May 8, 2024

User Story

As a user of the Solid Design System, I would like to utilize an additional attribute to be used for tracking implemenatation, as well as an additional attribute to be used for testing on each component, so that solid components can be used with the current tracking implementation and within the current testing structure.

Suggested Solution

A global script adds the following attributes to each component:

  1. Tracking
    key: data-sd-version
    value: current version of the library (eg. 3.3.0)
  2. Testing
    key: data-sd-name
    value: component name (eg. sd-button)

Implementation details

This should be implemented as a one-time effort for all components, so e. g. in the sd-element, being the base component.

  1. The version could be easily replaced via Vite with some String replacement.
  2. Not sure about the component name, but even that should be possible via connectedCallback, which sets the attribute containing the tag of this and maybe having some kind of regex which removes numbers followed by dashes.

DoR

  • Item has business value
  • Item all subtasks have been estimated by the team
  • Item is clear and well-defined
  • Item dependencies have been identified and documented

DoD

  • Documentation has been created/updated (if applicable)
  • Migration Guide has been created/updated (if applicable)
  • Relevant E2E tests (Features, A11y, Bug fixes) are created/updated
  • Relevant stories (Features, A11y) are created/updated
  • Implementation works successfully on feature branch
@karlbaumhauer karlbaumhauer added the 🔧 code needs changes in code label May 8, 2024
@karlbaumhauer
Copy link
Contributor Author

@mariohamann assigned to you in order to read through it and see if anything is missing. I could not find any information for the tracking part and especially no information about the priority.

@yoezlem assigned to you in order to prioritize. I did not create it as epic, as we only have dev implementation for it. The testing prio is medium IMO.

@mariohamann
Copy link
Contributor

Updated and removed myself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔧 code needs changes in code
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants