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 - ADR: Improve modularity in USWDS #24

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

Conversation

mejiaj
Copy link

@mejiaj mejiaj commented Dec 19, 2024

Description

Proposal to improve modularity in USWDS. Breaking down the current USWDS package into smaller products will give teams greater flexibility and performance when building applications.

Closes #20.

Testing and review

Preview →

@mejiaj mejiaj force-pushed the adr/improve-modularity branch from f766615 to ae2c670 Compare December 19, 2024 17:27

## Consequences

### Benefits
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: may be good to explicitly call out performance and bundle size, since the hope is that increasing modularity will make it easier to make each package as small as possible

Copy link
Author

Choose a reason for hiding this comment

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

@heymatthenry good idea. Tried to capture in f5e50e8.


| Date | Status |
| ---------- | -------- |
| 2024-12-19 | Proposed |
Copy link
Author

Choose a reason for hiding this comment

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

chore: Update status before merge.

Suggested change
| 2024-12-19 | Proposed |
| 2024-12-19 | Approved |

@mejiaj mejiaj requested a review from heymatthenry February 5, 2025 15:19
@mejiaj mejiaj marked this pull request as ready for review February 12, 2025 17:16
Copy link
Contributor

@heymatthenry heymatthenry left a comment

Choose a reason for hiding this comment

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

Couple of small wording suggestions.

@annepetersen Would you like to be included on ADR PRs for wordsmithing purposes?


## Context

USWDS is becoming a set of products, in the form of tools and targets. To improve performance and provide flexibility to teams we should make USWDS more modular by offering products such as:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
USWDS is becoming a set of products, in the form of tools and targets. To improve performance and provide flexibility to teams we should make USWDS more modular by offering products such as:
USWDS is becoming a set of products, in the form of tools and targets: targets, meaning the formats and code the system will generate, and tools meaning the system components that generate them. To improve performance and provide flexibility to teams we should make USWDS more modular by offering products such as:


## Decision

We'll create additional products and resources that teams can use individually, such as: utilities, tokens, SASS helpers, and HTML components.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
We'll create additional products and resources that teams can use individually, such as: utilities, tokens, SASS helpers, and HTML components.
By refactoring existing code and creating new products, such as utilities, tokens, SASS helpers, and HTML components, we will support more modular, composable ways of working.

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.

USWDS-Proposals - ADR: Create a suite of tools to improve modularity in USWDS Core
3 participants