-
Notifications
You must be signed in to change notification settings - Fork 211
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
docs: clarify browser support and add issue severity classification #4662
Conversation
Branch preview |
Tachometer resultsCurrently, no packages are changed by this PR... |
Lighthouse scores
What is this?Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on Transfer Size
Request Count
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking great so far. Since you're in here, could we also add some more specificity around using webcomponents.dev to provide your reproduction?
in bug_report.yaml
:
line 65: "Sample code or abstract reproduction which illustrates the problem"
in contributing.md
(it wouldn't let me comment on these lines for some reason)
lines 51-53
"Please reproduce your issue in an abstract environment, preferrably webcomponents.dev (use the existing link provided there). Screenshots or videos in your local dev environment are not sufficient enough to help us identify whether or not the issue originates from our library."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one little thing. Otherwise, looks good! Thank you.
Co-authored-by: Najika Halsema Yoo <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Woohoo! Thank you!!!
Description
This PR adds a new section to the
CONTRIBUTING.md
andREADME
files to provide contributors with clear guidelines on the target browsers we support. It also adds a detailed defect severity classification table into the contribution guidelines and adds a "Issue Severity" dropdown field to the GitHub issues template.Related issue(s)
Motivation and context
We are aiming for greater transparency while at the same time formalizing some of our current practices and support mechanisms.
Types of changes
Checklist
Best practices
This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against
main
.