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

Severity #16921

Merged
merged 25 commits into from
Jul 9, 2024
Merged

Severity #16921

merged 25 commits into from
Jul 9, 2024

Conversation

sstrubberg
Copy link
Member

@sstrubberg sstrubberg commented Jul 8, 2024

Brief

As a maintainer of the Core Components of Carbon, I would argue that we have an incredibly polished process for triaging defects in our codebase and turning those bugs around into fixes in our regular sprint cadence.

However, I think things tend to fall apart when we extend the idea of triaging and fixing defects in the other pillars of our design system, our Figma kit and our Documentation. This PR aims to remedy that with a comprehensive point-of-view on our approach to applying severity to not only our Code, but our Kit and Docs as well.

Testing

To review, click on the Files changed tab above, then click the button to display rich diff.

image

Scroll down to the Triaging section to see the table.

I'm looking for feedback on not only these descriptions, but on the very idea of assigning severity to defects in not just our code, but our docs and our kits as well.

@sstrubberg sstrubberg requested a review from a team as a code owner July 8, 2024 13:36
Copy link

netlify bot commented Jul 8, 2024

Deploy Preview for v11-carbon-react ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 37a578b
🔍 Latest deploy log https://app.netlify.com/sites/v11-carbon-react/deploys/668d7edbbccefc0008588b85
😎 Deploy Preview https://deploy-preview-16921--v11-carbon-react.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jul 8, 2024

Deploy Preview for carbon-elements ready!

Name Link
🔨 Latest commit 37a578b
🔍 Latest deploy log https://app.netlify.com/sites/carbon-elements/deploys/668d7edb1d9e710008afaa2e
😎 Deploy Preview https://deploy-preview-16921--carbon-elements.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@aagonzales
Copy link
Member

aagonzales commented Jul 8, 2024

Initial thought on docs, I think we could break down "missing" into major and minor pieces.

Docs Sev 2: "The documentation is wrong or missing major details".

Docs Sev 3: "The documentation is mis-leading, somewhat true, or missing minor details"

  • Sev 3 does not impact the users understanding of how to use the component. Something like maybe a token was missed on the style tab.

Copy link
Member

@tay1orjones tay1orjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! One minor suggestion on the first column

docs/guides/support.md Outdated Show resolved Hide resolved
docs/guides/support.md Outdated Show resolved Hide resolved
docs/guides/support.md Outdated Show resolved Hide resolved
docs/guides/support.md Outdated Show resolved Hide resolved
sstrubberg and others added 4 commits July 8, 2024 14:16
Copy link
Member

@aagonzales aagonzales left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these are good for general descriptions. I think at some point we could better define what is considered "major" versus "minor"

@sstrubberg
Copy link
Member Author

sstrubberg commented Jul 8, 2024

I think these are good for general descriptions. I think at some point we could better define what is considered "major" versus "minor"

Agreed. In my mind, as we start to tackle these types of issues, we'll start to find harden our POV on major vs. minor. What's important is that we're identifing defects and having the conversations.

Copy link
Member

@alisonjoseph alisonjoseph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Copy link
Contributor

@elycheea elycheea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I apologize for nitpicking. We have some inconsistent usage of workaround, work-around, and work around. 😉

docs/guides/support.md Outdated Show resolved Hide resolved
docs/guides/support.md Outdated Show resolved Hide resolved
@sstrubberg
Copy link
Member Author

I apologize for nitpicking. We have some inconsistent usage of workaround, work-around, and work around. 😉

no apology needed! Fixing now!

@sstrubberg sstrubberg requested a review from elycheea July 9, 2024 16:13
Copy link
Member

@laurenmrice laurenmrice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this, Scott!

Copy link
Contributor

@oliviaflory oliviaflory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Scott!

@sstrubberg sstrubberg added this pull request to the merge queue Jul 9, 2024
Merged via the queue into carbon-design-system:main with commit e21d106 Jul 9, 2024
22 checks passed
@sstrubberg sstrubberg deleted the severity branch July 9, 2024 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants