You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adding new projects and adding existing projects to the Spectrum Web Components collection (including fork-to-workspace steps)
Naming conventions (swc-component-name pattern)
Replacing an existing project in the collection
Contributor docs navigation updated via update-nav.js so the new guide appears under Contributor guides (breadcrumbs and “Beneath this doc” TOC).
Motivation and context
Provides the team with a single reference for updating StackBlitz examples, managing the shared collection, and onboarding others (who to ask for access, where to fork, how to add to the collection). Keeps process and naming consistent.
I have reviewed the Accessibility Practices for this feature, see: Aria Practices
I have added automated tests to cover my changes.
I have included a well-written changeset if my change needs to be published.
I have included updated documentation if my change required it.
Reviewer's checklist
Includes a Github Issue with appropriate flag or Jira ticket number without a link
Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
Automated tests cover all use cases and follow best practices for writing
Validated on all supported browsers
All VRTs are approved before the author can update Golden Hash
Manual review test cases
New guide is discoverable from CONTRIBUTOR-DOCS root and nav renders
Open CONTRIBUTOR-DOCS/README.md and confirm “Maintaining StackBlitz examples for Spectrum Web Components” appears under “Beneath this doc” (nested under Contributor guides).
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Component:DocumentationIssues or PRs involving changes to docs or docs website. Component prefix is for Jira integration.Status:Ready for mergePR has 2 approvals, all tests pass, and is ready to merge
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a new contributor guide for maintaining StackBlitz examples used by the Spectrum Web Components library.
CONTRIBUTOR-DOCS/01_contributor-guides/10_using-stackblitz.mdswc-component-namepattern)update-nav.jsso the new guide appears under Contributor guides (breadcrumbs and “Beneath this doc” TOC).Motivation and context
Provides the team with a single reference for updating StackBlitz examples, managing the shared collection, and onboarding others (who to ask for access, where to fork, how to add to the collection). Keeps process and naming consistent.
Related issue(s)
Author's checklist
I have added automated tests to cover my changes.I have included a well-written changeset if my change needs to be published.Reviewer's checklist
patch,minor, ormajorfeaturesManual review test cases
New guide is discoverable from CONTRIBUTOR-DOCS root and nav renders
CONTRIBUTOR-DOCS/README.mdand confirm “Maintaining StackBlitz examples for Spectrum Web Components” appears under “Beneath this doc” (nested under Contributor guides).CONTRIBUTOR-DOCS/01_contributor-guides/README.mdand confirm the same guide appears under “Beneath this doc.”CONTRIBUTOR-DOCS/01_contributor-guides/10_using-stackblitz.mdand confirm breadcrumbs and “In this doc” TOC render correctly.Doc is clear, valuable, and helpful to a human who needs it
CONTRIBUTOR-DOCS/01_contributor-guides/10_using-stackblitz.mdin full as if you need to update a StackBlitz example or get access.Device review