Skip to content

Commit

Permalink
docs(README): add how can I help section
Browse files Browse the repository at this point in the history
  • Loading branch information
levithomason committed Jun 22, 2016
1 parent d856e7c commit 7cbe983
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,23 @@ We then use [Webpack][13] to create `bundle.js` from `App.js` and include it in

For more complete examples, check out the [Doc Site][2].

## How Can I Help?

### v1.0 Migrations

We're making two migrations right now:

1) [Moving legacy component APIs to our v1 API][15].
2) [Removing jQuery and SUI JS][11].

Each of these issues includes a list of components and more information on how you can help.

### New Components

There is an [issue][14] for every missing component. They are all labeled `enhancement` `help wanted` and we're accepting PRs for these.

Be sure to checkout the above migrations before embarking on a new component. All new components should be written in accordance with the migrations above.

## Our Principles

[TechnologyAdvice][9] has been [dogfooding][10] Stardust in production since fall of 2015. This living list is updated as we iterate. We'll lock it in as our v1.0 constitution soon.
Expand Down Expand Up @@ -183,3 +200,5 @@ Originally created with :heart: at [TechnologyAdvice][9].
[11]: https://github.com/TechnologyAdvice/stardust/issues/247
[12]: https://github.com/TechnologyAdvice/stardust/issues/243
[13]: https://webpack.github.io
[14]: https://github.com/TechnologyAdvice/stardust/issues
[15]: https://github.com/TechnologyAdvice/stardust/issues/269

0 comments on commit 7cbe983

Please sign in to comment.