search

seas-computing / mark-one

A UI component library for building React Apps (in development)
https://seas-computing.github.io/mark-one/
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Initial Readme and Contributing Guide #1

Closed jonseitz closed 5 years ago

jonseitz commented 5 years ago

Adds an initial README, along with a brief guide for creating new components under CONTRIBUTING.md.

Let me know if there are any things in there that don't make sense to you. I've tried not to get too deep in step-by-step instructions but I may have gone a little too far in that respect. So if it's not totally clear I can go back and flesh out the details a little more.

natalynyu commented 5 years ago

@jonseitz I read through this again, and it looks good to me!

jonseitz commented 5 years ago

Thanks @natalynyu! There should be an option under the "Review changes" button in the corner where you can mark the pull request as approved. It's not strictly required at the moment, but it's helpful for keeping a record of who reviewed what in the future.

jonseitz commented 5 years ago

@chrxr this branch doesn't actually have any components, so I guess that's the default styleguidist error when it can't find anything to render. Not very helpful, is it? npm run start should work on one of the other branches (like global-theme) if you want to test it out.

chrxr commented 5 years ago

Ah, gotcha. In which case, the docs here look great.