-
Notifications
You must be signed in to change notification settings - Fork 3
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
USWDS-proposals: Add directory for pre-alpha web components #18
base: main
Are you sure you want to change the base?
Conversation
adding links and naming
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.
With the edits I made, looks good to me. But check my work too, y'all. 😅
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.
A couple potential suggestions and questions! Nothing blocking.
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.
Question: Does the rest of the proposals file structure make sense with this change? Should we create a core dir as well?
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.
This is a good note. The repo was originally designed to just be for component proposals, and I think the recent repo growth is showing strangely in both the file structure and base README. Now that the repo will also include ADRs and Elements pre-alphas, we should at least address that in the README and consider if the file structure still makes sense. I've opened #19 to address the README piece of this.
web-components/_template.md
Outdated
|
||
<!-- | ||
| USWDS 3 variant | Web components variant | Description | Defined via | | ||
|--------|--------|--------|--------| | ||
| | | | | | ||
--> |
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.
Question: Not sure I follow what the the Web components variant
is supposed to be listed as here.
Is this just the name of the variant? Would this differ from the USWDS 3 variant?
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.
Thanks for creating this @amyleadem. Overall it looks good. Left a few comments, but nothing is blocking.
I've also made some formatting changes using the built-in markdown formatter in Prettier.
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.
@amyleadem can you look into the formatting issue? We might have to move some code blocks out of comments.
Otherwise LGTM
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.
@amyleadem can you look into display issues showing up in the preview?
Summary
Create a README and template for the web component pre-alphas.
Note
The pre-alpha requirements are documented in the Web Components release lifecycle doc (Google docs 🔒)
Preview links
Testing and review