Skip to content

Commit

Permalink
docs(contributing): add contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
levithomason committed Jun 29, 2016
1 parent fb86355 commit 3d5c686
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ CONTRIBUTING
- [API](#api)
- [SUI HTML Classes](#sui-html-classes)
- [SUI HTML Markup](#sui-html-markup)
- [State](#state)
- [AutoControlledComponent](#autocontrolledcomponent)
- [Testing](#testing)
- [Common Tests](#common-tests)
- [State](#state)
- [AutoControlledComponent](#autocontrolledcomponent)
- [Documentation](#documentation)
- [Website](#website)
- [Components](#components)
Expand Down Expand Up @@ -257,14 +257,6 @@ class List {
}
````
### State
TODO
#### AutoControlledComponent
TODO
### Testing
Run tests during development with `npm run test:watch` to re-run tests on file changes.
Expand Down Expand Up @@ -336,6 +328,14 @@ This is the only required test. It ensures a consistent baseline for the framew
1. Base `className`s are applied
1. Component is exported if public / hidden if private

### State

TODO

#### AutoControlledComponent

TODO

## Documentation

Our docs are generated from doc block comments, `propTypes`, and hand written examples.
Expand Down Expand Up @@ -398,12 +398,12 @@ Label.propTypes = {

### Examples

>This section is lacking in instruction as the the docs are set to be overhauled (PRs welcome!).
Usage examples for a component live in `docs/app/Examples`. The examples follow the SUI doc site examples.

Adding documentation for new components is a bit tedious. The best way to do this (for now) is to copy an existing component's and update them.

Yes, we're sorry. This will be reworked. PRs welcome!

[1]: https://github.com/TechnologyAdvice/stardust/blob/master/test/specs/commonTests.js
[2]: https://facebook.github.io/react/docs/forms.html#controlled-components
[3]: https://facebook.github.io/react/docs/forms.html#uncontrolled-components
Expand Down

0 comments on commit 3d5c686

Please sign in to comment.