Skip to content

Commit

Permalink
Merge branch 'develop' of https://github.com/uswds/uswds-next into al…
Browse files Browse the repository at this point in the history
…/add-identifier-storybook
  • Loading branch information
amyleadem committed Aug 16, 2024
2 parents c7a2ade + b94a090 commit 79f63e5
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 19 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing to USWDS web components

Thank you for your interest in contributing to USWDS web components.

> [!Important]
>
> **This repo is currently in beta and not yet ready for community code contributions.**
>
> While the USWDS core team works through decisions about architecture and style, we ask that you do not submit pull requests. Instead, we encourage you to contribute by your sharing your bug reports, ideas, concerns, questions, and experiences with the USWDS core team and community.
## How can I contribute?

### Filing a bug report

If you have discovered a bug that has not yet been reported in our [issues backlog](https://github.com/uswds/web-components/issues), let us know by [submitting an issue](https://github.com/uswds/web-components/issues/new). We are in beta and may not be able to respond immediately, but we will address as soon as as we are able.

### Starting a discussion

If you want to share ideas, questions, or concerns with the USWDS core team and community, you can participate in any of our [open discussions](https://github.com/uswds/web-components/discussions) or [start a new discussion](https://github.com/uswds/web-components/discussions/new/choose).

### Submitting a pull request

At this time, we are not accepting code contributions from the community. We expect to open up community pull request submissions in early 2025, so check back later for instructions on how to contribute pull requests to USWDS web components.

## Code of Conduct

USWDS is committed to building a safe, welcoming, harassment-free culture for everyone. USWDS is a part of the Technology Transformation Services (TTS) within the General Services Administration (GSA) and we expect everyone to follow the [GSA TTS Code of Conduct](https://handbook.tts.gsa.gov/about-us/code-of-conduct/).

We encourage you to read this project’s Contribution Guide (you are here) and its [README](https://github.com/uswds/web-components). If you want to read more about our open source policy or have questions, check out the [18F Open Source Policy GitHub repository](https://github.com/18f/open-source-policy) or send us an [email](mailto:[email protected]).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Over the course of the next several months (and beyond), we will incrementally b

## Upgrading to Web Components

We are releasing these Web Components incrementally with the intent that they can also be added incrementally to existing sites that are currently using USWDS. If you are not currently using USWDS or are using a version older USWDS 3, we recommend adopting version 3 in the near term rather than waiting until the full suite of Web Components is production-ready.
We are releasing these Web Components incrementally with the intent that they can also be added incrementally to existing sites that are currently using USWDS. If you are not currently using USWDS or you are using a version older than USWDS 3, we recommend adopting version 3 in the near term rather than waiting until the full suite of Web Components is production-ready.

## Guiding Principles

Expand Down
27 changes: 10 additions & 17 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"storybook": "^8.2.7",
"vite": "^5.3.5",
"vitest": "^1.6.0",
"wait-on": "^7.2.0"
"wait-on": "^7.1.0"
},
"optionalDependencies": {
"@rollup/rollup-linux-x64-gnu": "^4.20.0"
Expand Down

0 comments on commit 79f63e5

Please sign in to comment.