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

USWDS-proposals: Add directory for pre-alpha web components #18

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Nov 26, 2024

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

  • Confirm that the location for this directory makes sense
  • Confirm that the name for this directory makes sense
  • Confirm the template is comprehensive and will capture the decisions we need to make during this phase
  • Confirm the format is intuitive and follows a logical order
  • Confirm the README addresses necessary topics and is free from error

web-components/README.md Outdated Show resolved Hide resolved
@amyleadem amyleadem marked this pull request as ready for review November 26, 2024 20:44
@amyleadem amyleadem requested a review from a team as a code owner November 26, 2024 20:44
adding links and naming
annepetersen
annepetersen previously approved these changes Nov 26, 2024
Copy link
Contributor

@annepetersen annepetersen left a 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. 😅

Copy link

@mahoneycm mahoneycm left a 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.

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?

Copy link
Contributor Author

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/README.md Outdated Show resolved Hide resolved
web-components/_template.md Outdated Show resolved Hide resolved
web-components/_template.md Outdated Show resolved Hide resolved
Comment on lines 49 to 54

<!--
| USWDS 3 variant | Web components variant | Description | Defined via |
|--------|--------|--------|--------|
| | | | |
-->

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?

web-components/_template.md Outdated Show resolved Hide resolved
Copy link
Contributor

@mejiaj mejiaj 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 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.

web-components/README.md Outdated Show resolved Hide resolved
web-components/_template.md Outdated Show resolved Hide resolved
web-components/_template.md Outdated Show resolved Hide resolved
web-components/README.md Outdated Show resolved Hide resolved
web-components/_template.md Outdated Show resolved Hide resolved
web-components/_template.md Outdated Show resolved Hide resolved
web-components/_template.md Show resolved Hide resolved
@amyleadem amyleadem changed the title USWDS-proposals: Add web-components directory USWDS-proposals: Add directory for pre-alpha web components Dec 10, 2024
Copy link
Contributor

@mejiaj mejiaj left a 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

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

5 participants