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

Unit test coverage for @carbon/ibm-products components #6101

Open
8 of 13 tasks
elycheea opened this issue Sep 23, 2024 · 3 comments
Open
8 of 13 tasks

Unit test coverage for @carbon/ibm-products components #6101

elycheea opened this issue Sep 23, 2024 · 3 comments
Assignees
Labels
Epic role: dev type: infrastructure 🤖 Issues related to devops, builds, packaging
Milestone

Comments

@elycheea
Copy link
Contributor

elycheea commented Sep 23, 2024

This is a parallel issue to the work that @guidari has been doing in @carbon/react.

REF carbon-design-system/carbon#16319

The goal of this workstream is to increase confidence in each component, not just to increase coverage. It’s better to have 80% coverage with high-quality tests than 100% coverage with low-quality tests.

Important

Read the Carbon core kickoff notes below for implementation instructions and tips

Add code coverage CI check

Preview Give feedback
  1. 1 of 2
    role: dev type: infrastructure 🤖
    AlexanderMelox
  2. role: dev type: infrastructure 🤖
    AlexanderMelox

Evaluate current test coverage

Preview Give feedback
  1. 2 of 35
    role: dev type: infrastructure 🤖 type: process 🎞️
    davidmenendez

Tests under 80% coverage

Preview Give feedback
  1. Debt component: AddSelect role: dev status: needs tests
  2. Debt role: dev status: needs tests
  3. component: Carousel status: needs tests type: enhancement 💡
    AlexanderMelox
  4. component: Coachmark status: needs tests type: enhancement 💡
    AlexanderMelox
  5. Debt role: dev status: needs tests
  6. component: GuideBanner status: needs tests type: enhancement 💡
    devadula-nandan
  7. component: Interstitial screen status: needs tests type: enhancement 💡
    anamikaanu96
  8. component: SidePanel status: needs tests type: enhancement 💡
    sangeethababu9223
  9. Debt component: StatusIcon role: dev status: needs tests
  10. Debt role: dev status: needs tests
@github-project-automation github-project-automation bot moved this to Needs triage 🧐 in Carbon for IBM Products Sep 23, 2024
@elycheea elycheea added type: infrastructure 🤖 Issues related to devops, builds, packaging role: dev and removed status: needs triage 🕵️‍♀️ labels Sep 24, 2024
@elycheea elycheea moved this from Needs triage 🧐 to Backlog 🌋 in Carbon for IBM Products Sep 24, 2024
@elycheea elycheea moved this from Backlog 🌋 to Needs refinement 🤓 in Carbon for IBM Products Sep 24, 2024
@elycheea elycheea added this to Roadmap Oct 7, 2024
@github-project-automation github-project-automation bot moved this to Triage in Roadmap Oct 7, 2024
@elycheea elycheea moved this from Triage to Now 💫 in Roadmap Oct 7, 2024
@davidmenendez davidmenendez moved this from Needs refinement 🤓 to Backlog 🌋 in Carbon for IBM Products Oct 16, 2024
@ljcarot
Copy link
Member

ljcarot commented Oct 30, 2024

@elycheea Can you please check the list of components and patterns above and remove any that have been flagged for deprecation? Doesn't make sense to put the effort in to any that will be deprecated this year.

@elycheea
Copy link
Contributor Author

I’ve removed the following from the list as components that are or should be deprecated in the near term.

  • ActionSet (internal; potential to replace with ButtonSet)
  • ComboButton (deprecated)
  • DataSpreadsheet (to deprecate)
  • Datagrid (to deprecate)
  • EditUpdateCards (to deprecate)
  • FilterPanel (to deprecate)
  • Nav (to deprecate)
  • StatusIndicator (to deprecate)
  • UserProfileImage (to deprecate after UserAvatar release)

We can probably also deprioritize (and remove) the following that are being recategorized as utilities. If they are rewritten, we’ll see the coverage report in the PRs for them.

  • ScrollGradient
  • StringFormatter
  • TagOverflow
  • TruncatedList

Lastly, CreateModal, StatusIcon and EmptyState I’ve left in place for now since the latter two may have new versions but unclear when those will be delivered. And CreateModal we haven’t discussed more directly although I would recommend deprioritizing otherwise since we could rewrite this as pattern code.

@elycheea elycheea added the Epic label Oct 31, 2024
@ljcarot ljcarot added this to the 2025 Q1 milestone Dec 18, 2024
@ljcarot ljcarot moved this from Backlog 🌋 to In progress in Carbon for IBM Products Dec 18, 2024
@elycheea
Copy link
Contributor Author

elycheea commented Jan 2, 2025

@ljcarot Compared the original list to Codecov and removed components/utilities that already reached 80% coverage. Converted any remaining tasks to issues.

Also removed TagOverflow which is still under 80% because @davidmenendez and @makafsal will look into coverage as part of #6601

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic role: dev type: infrastructure 🤖 Issues related to devops, builds, packaging
Projects
Status: In progress
Status: Now 💫
Development

No branches or pull requests

2 participants