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.

Sign up for GitHub

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

Jump to bottom

Add more documentation around how to contribute and write new components #73

Closed
suzubara opened this issue Apr 15, 2020 · 0 comments · Fixed by #248
Closed

Add more documentation around how to contribute and write new components #73

suzubara opened this issue Apr 15, 2020 · 0 comments · Fixed by #248
Assignees
@haworku
Labels
type: documentation Improvements or additions to documentation

Comments

@suzubara
Copy link
Contributor

suzubara commented Apr 15, 2020 •
edited by haworku
Loading

Write some more documentation specifically around how to write new components. Include guidance around:

  • How to decide whether to add a new component
  • Once decided, make sure it is abstract enough for general usage but also fits in the USWDS
  • Make sure props type inherits the HTML element attributes
  • Make sure to add corresponding stories and tests
  • Make sure to export the new component from the package entrypoint (index.ts)

Add a PR template.
@suzubara suzubara added the type: documentation Improvements or additions to documentation label Apr 15, 2020
@suzubara suzubara mentioned this issue May 22, 2020
Merged
@haworku haworku mentioned this issue May 22, 2020
Merged
@haworku haworku self-assigned this May 22, 2020
This was referenced Jun 2, 2020
Closed
Merged
haworku added a commit that referenced this issue Jun 5, 2020
@haworku
docs: Add new pull request template #73 (#226)
f030ba6
@haworku haworku mentioned this issue Jun 8, 2020
Merged
haworku added a commit that referenced this issue Jun 12, 2020
@haworku
docs: adding new components docs #73 (#248)
981956f 
* docs: reword developing, contributing md, add to codeowners
DanielMiller-agile6 pushed a commit to DanielMiller-agile6/react-uswds that referenced this issue Jun 25, 2020
@haworku @DanielMiller-agile6
docs: Add new pull request template trussworks#73 (trussworks#226)
76df152
@haworku haworku mentioned this issue Jun 29, 2020
Merged
haworku added a commit that referenced this issue Jun 29, 2020
@haworku
docs: Add new pull request template #73 (#226)
040fc1d
haworku added a commit that referenced this issue Jun 29, 2020
@haworku
docs: adding new components docs #73 (#248)
24c4b08 
* docs: reword developing, contributing md, add to codeowners
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@haworku haworku

Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: adding new components docs, rework development docs #73 trussworks/react-uswds
2 participants
@suzubara @haworku