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 documentation #46

Open
maiertech opened this issue Jul 23, 2019 · 0 comments
Open

Add documentation #46

maiertech opened this issue Jul 23, 2019 · 0 comments
Labels
priority 1 This is a high priority issue

Comments

@maiertech
Copy link
Contributor

A more elaborate README (similar to what you would find in a open source project) that covers:

  • high-level overview of app architecture (create-react-app, react-router, styled-components via calcite-react etc.)
  • Quick overview of folders
  • Quick overview of custom components architecture:
    • separation of styling and state/logic
    • how to run Storybook
  • How do I
    • Install dependencies
    • Run the app locally
  • What to watch out for when contributing:
    • Prettier/ESLint configs
@gonzalezmorales gonzalezmorales added the priority 1 This is a high priority issue label Jul 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
priority 1 This is a high priority issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@maiertech @gonzalezmorales