docs: add documentation for Trussels #190

suzubara · 2020-05-21T18:38:02Z

Adds some documentation specifically for Trussels who are looking to get more or less involved in this project! I also took the opportunity to update the README following the best practices outlined at https://github.com/RichardLitt/standard-readme

Fixes #185
Fixes #97

suzubara · 2020-05-21T20:42:01Z

README.md

- [ ] Make sure new components are added as package exports
+## Maintainers
+
+- [@suzubara](https://github.com/suzubara)


Please add yourself here as part of this PR! (if you read the doc about active maintainers and would like to be one right off the bat)

suzubara · 2020-05-21T20:42:24Z

README.md

@@ -56,30 +67,28 @@ Also make sure to include the following in order to import the compiled CSS from

 **[More info about using USWDS CSS & SCSS](./docs/scss.md)**

-## Roadmap


fyi: I made sure any outstanding roadmap items were reflected in github issues before deleting this section

eamahanna · 2020-05-22T00:18:19Z

README.md

+
+## License
+
+[Copyright 2019, TrussWorks, Inc.](../LICENSE)


Is this the standard licensing practice for Truss?

Yes I believe so. FYI there is a TDR drafted by @ferlatte I saw circulating about what licenses we use internally at Truss, goes into more detail about what licenses we should use and when.

👍 I'm not entirely sure if we have the right license but if we need to change it I'd handle that as a separate issue!

eamahanna · 2020-05-22T00:23:40Z

docs/for_trussels.md

+    - especially any that are labeled `good first issue` if this is your first time contributing to ReactUSWDS
+  - Issues in the **Needs requirements** column are undergoing active discussion and would probably benefit from your point of view!
+- Browse [open issues](https://github.com/trussworks/react-uswds/issues) to see if there are any new issues that need to be labeled or prioritized
+


I think another good onboarding step would be to check in with the other active maintainers to help get a feel for where help is needed and things along those lines :) (just an opinion though)

good idea, adding this!

eamahanna · 2020-05-22T00:24:20Z

docs/for_trussels.md

+- Attend and help facilitate the ReactUSDS check-in meetings regularly
+- Pay attention to [USWDS](https://github.com/uswds/uswds) updates, and create new issues needed to help this project stay up-to-date with them
+- Participate actively in PR reviews, issue discussion, and project roadmap planning
+- Keep an eye on any security alerts that come up, and make sure they are addressed promptly


Do we have any documentation about what to do when security alerts arise and how to handle them?

nooope, I'll add a brief note on that and maybe we can add onto it as things come up..

eamahanna

Nice job suz. This looks good. I just had a few comments, but no blockers.

duncan-truss

Very well written!

gidjin

LGTM! 🚢

haworku · 2020-05-22T15:59:20Z

README.md

 1. [Roadmap](#roadmap)

-## Goals
+## Background

 The primary deliverable is a published npm package that can be included as a dependency in other projects that use USWDS with React. In order for these components to be actually useful, they should follow best practices and baseline standards for accessible, semantic, markup; be well-tested across browsers and devices; and allow for an appropriate level of customization in implementation (such as via React `props`). Therefore we should adhere to these development guidelines as much as possible:


Would love to give some specific examples one day (maybe a link to a blog post or a doc we make 💡 ) with ideas for how to make your components more flexible with props and types.

agreed, I could see this falling into #73 ?

haworku

Thanks for this work!

* Bump standard-version from 7.1.0 to 8.0.0 Bumps [standard-version](https://github.com/conventional-changelog/standard-version) from 7.1.0 to 8.0.0. - [Release notes](https://github.com/conventional-changelog/standard-version/releases) - [Changelog](https://github.com/conventional-changelog/standard-version/blob/master/CHANGELOG.md) - [Commits](conventional-changelog/standard-version@v7.1.0...v8.0.0) Signed-off-by: dependabot-preview[bot] <[email protected]> * Created issue templates Created issue templates for feature request & bug report, with default labels. * fix: removes the usa-search class name from the form component (#184) fix #163 * fix: accept id and name props for Search component input field (#183) * fix: accept id and name props for Search component input field * fix: qualify id and name props for input field to not clash with form fix #162 * feat: add dateInput component for forms (#144) * Added dateInput component and dateInputGroup component for forms * fix: extends header menu to accept list props for corresponding id (#188) fix #165 * fix: update gov banner to uswds version 2.7.0 * chore: upgrade uswds to 2.7.0 * docs: add documentation for Trussels (#190) * docs: add documentation for Trussels * docs: clean up readme to meet project standards * docs: add to active maintainers * docs: add first pass of security policy Co-authored-by: HANA <[email protected]> * feat: add Footer component #142 (#146) - adds slim, medium, and big footers with mobile styles - adds new components, specifically Address, Footer, FooterNav, FooterExtendedNavList, Logo, SocialLinks * build(deps-dev): bump @testing-library/jest-dom from 5.7.0 to 5.8.0 (#197) * build(deps-dev): bump typescript from 3.9.2 to 3.9.3 (#196) * build(deps-dev): bump @storybook/react from 5.3.18 to 5.3.19 (#198) * build(deps-dev): bump stylelint from 13.4.1 to 13.5.0 (#199) * build(deps-dev): bump lint-staged from 10.2.4 to 10.2.6 (#200) * build(deps-dev): bump @storybook/addon-info from 5.3.18 to 5.3.19 (#201) * feat(rangeinput): creates form RangeInput component, test, and stories (#194) * feat(rangeinput): creates form RangeInput component, test, and stories * feat: add RangeInput component to index.ts for entrypoint export * feat: remove overalpping interface props with HTMLInputAttributes type * feat: require id and name props, remove label, remove redundant unpack * feat: remove unused label import in component, show label usage in story fixes #81 * docs: add landing page and documentation page template stories (#195) * docs: add landing page and documentation page template stories * docs(storybook): add current class to header navigation * ci: lint PR titles instead of commits #159 (#210) * chore: add semantic pr workflow * chore: update workflow * Remove commitlint hook * Clarify PR linting requirement Co-authored-by: HANA <[email protected]> * chore(release): 1.4.0 * Remove duplicate entry from changelog Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com> Co-authored-by: Duncan <[email protected]> Co-authored-by: Emily Mahanna <[email protected]> Co-authored-by: HANA <[email protected]>

docs: add documentation for Trussels

1547719

suzubara requested review from gidjin, sarboc and tinyels as code owners May 21, 2020 18:38

docs: clean up readme to meet project standards

5d3df2f

suzubara commented May 21, 2020

View reviewed changes

suzubara requested review from sojeri, duncan-truss, eamahanna and haworku May 21, 2020 20:46

eamahanna reviewed May 22, 2020

View reviewed changes

eamahanna approved these changes May 22, 2020

View reviewed changes

duncan-truss approved these changes May 22, 2020

View reviewed changes

gidjin approved these changes May 22, 2020

View reviewed changes

docs: add to active maintainers

5d2b7f8

haworku reviewed May 22, 2020

View reviewed changes

haworku approved these changes May 22, 2020

View reviewed changes

docs: add first pass of security policy

1fafeb5

suzubara merged commit 14b188b into develop May 22, 2020

suzubara deleted the sr-trussel-docs-185 branch May 22, 2020 18:06

haworku mentioned this pull request Jun 29, 2020

chore(release): 1.6.0 #286

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add documentation for Trussels #190

docs: add documentation for Trussels #190

suzubara commented May 21, 2020 •

edited

Loading

suzubara May 21, 2020

suzubara May 21, 2020

eamahanna May 22, 2020

haworku May 22, 2020

suzubara May 22, 2020

eamahanna May 22, 2020

suzubara May 22, 2020

eamahanna May 22, 2020

suzubara May 22, 2020

eamahanna left a comment

duncan-truss left a comment

gidjin left a comment

haworku May 22, 2020

suzubara May 22, 2020

haworku left a comment •

edited

Loading

		@@ -56,30 +67,28 @@ Also make sure to include the following in order to import the compiled CSS from

		[More info about using USWDS CSS & SCSS](./docs/scss.md)

		## Roadmap

docs: add documentation for Trussels #190

docs: add documentation for Trussels #190

Conversation

suzubara commented May 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eamahanna left a comment

Choose a reason for hiding this comment

duncan-truss left a comment

Choose a reason for hiding this comment

gidjin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haworku left a comment • edited Loading

Choose a reason for hiding this comment

suzubara commented May 21, 2020 •

edited

Loading

haworku left a comment •

edited

Loading