Skip to content

Post Getting Started Updates_Nov 30, 2021#4412

Merged
thisisdano merged 4 commits into
developfrom
MS-Update-README
Mar 9, 2022
Merged

Post Getting Started Updates_Nov 30, 2021#4412
thisisdano merged 4 commits into
developfrom
MS-Update-README

Conversation

@mikki-stacey

Copy link
Copy Markdown
Contributor

Description

Include a high-level description of the issue your pull request fixes; include only one issue per pull request. Please also link to the GitHub issue it resolves.

Additional information

Include any of the following (as necessary):

  • Relevant research and support documents
  • Type of content review needed: stylistic or copy editing
  • Screenshot images
  • Notes

Before you hit Submit, make sure you’ve done whichever of these applies to you:

  • Follow the 18F Front End Coding Style Guide and Accessibility Guide.
  • Run npm test and make sure the tests for the files you have changed have passed.
  • Run your code through HTML_CodeSniffer and make sure it’s error free.
  • Title your pull request using this format: [Website] - [UI component]: Brief statement describing what this pull request solves.

The following updates have been made to remove redundancies with the updated Getting Started guidance for developers and per conversation with the dev team:
–"Download and install" has been made more specific: "Download and install without npm."
–"Install using npm" has been removed. References to this section have tentatively been replaced with "NEW LINK," and prior to publication, will be replaced with the link to the updated web guidance for Getting Started for devs.
–Content of "Use another framework or package manager" has been moved up to appear under "Using the design system."
–"Accessibility" has been updated to note a few of the tools we use to ensure USWDS is accessible.
Added link to new dev guidance
@mikki-stacey mikki-stacey requested a review from mejiaj December 7, 2021 14:50
@mejiaj mejiaj marked this pull request as ready for review December 7, 2021 15:34
Comment thread README.md Outdated

@mejiaj mejiaj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good! But we need to find a solution for SASS Requirements section.

You can view what the page would like like on the doc's site here →.

I've also updated the links to point to new sections in the Maturity Model page.

Comment thread README.md
Co-authored-by: James Mejia <james.mejia@gsa.gov>

@thisisdano thisisdano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's make the change James suggested and then we can merge.

@mikki-stacey

Copy link
Copy Markdown
Contributor Author

James suggestion was incorporated as part of this PR in the site repo: https://github.com/uswds/uswds-site/pull/1370/files

@mejiaj mejiaj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, thank you @mikki-stacey!

@thisisdano thisisdano merged commit 7349ddf into develop Mar 9, 2022
@thisisdano thisisdano deleted the MS-Update-README branch March 9, 2022 18:16
mejiaj pushed a commit that referenced this pull request Apr 8, 2022
Post Getting Started Updates_Nov 30, 2021
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.

4 participants