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

Add "how to contribute" content, and update README with more what/why details #15

Open
erichuffman opened this issue Sep 19, 2022 · 1 comment
Assignees

Comments

@erichuffman
Copy link
Collaborator

erichuffman commented Sep 19, 2022

  1. Update the README with an overview of what the project is and why
  2. Create a "How to contribute" page and/or section that details steps to contribute, highlighting workflow requirements (node version, a placeholder for running tests, etc.)
@erichuffman erichuffman changed the title Update About page to include "how to contribute" content Add "how to contribute" content, and update README with more what/why details Oct 3, 2022
@erichuffman erichuffman self-assigned this Oct 17, 2022
@erichuffman
Copy link
Collaborator Author

erichuffman commented Nov 14, 2022

Things to address:

  1. Documentation section naming convention / file structure

Take a look at: https://storybook.js.org/docs/react/writing-stories/naming-components-and-hierarchy

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

No branches or pull requests

1 participant