diff --git a/HELP.md b/HELP.md index c97a91a0a..ebe41cf70 100644 --- a/HELP.md +++ b/HELP.md @@ -2,12 +2,14 @@ Do you want to make sitespeed.io even better? Here's how you can help out! ## Developers -We love to have more people involved in making sitespeed.io better. We are constantly working on adding more documentation and trying to write more information in the issues so its easier to help out. If there's an issue that you want to help out, ping the issue and we'll help you out getting started. +We love to have more people involved in making sitespeed.io better. We are constantly working on adding more documentation and trying to write more information in the issues so its easier to help out. If there's an [issue](https://github.com/sitespeedio/sitespeed.io/issues) that you want to help out, ping the issue and we'll help you getting started. + +Have you already implemented your own [postTask](http://www.sitespeed.io/documentation/#postTasks)? Add it as a [gist](http://gist.github.com/) and show people how you done it. ## Companies -Do you use sitespeed.io in your everyday work? Then we have a perfect proposition for you! Have a hack day with focus on sitespeed.io for your team and contribute back. Maybe there's a function you think is missing? Create it. Check out the **Functionality wanted** section. Have you already implemented your own postTasks? Add it as a gist and show people how you done it. +Do you use sitespeed.io in your everyday work? Then we have a perfect proposition for you! Have a hack day with focus on sitespeed.io for your team and contribute back. Pick one the things in the **Help wanted** section. Or maybe there's a function you think is missing? Create it. Contribute back. -# Functionality wanted +# Help wanted We have a couple of functions that we have on the wish list but haven't had time to implement. Or even think about implementing. ## A HAR viewer We produce [HAR](http://www.softwareishard.com/blog/har-12-spec/) files today but we don't display them. We really like the [SimpleHar](http://rafacesar.github.io/simplehar/) and the old classic [HarViewer](http://www.softwareishard.com/har/viewer/) and we are pretty confident that it is possible to write a configurable HAR viewer that produces SVG and don't use JQuery. We would love to add that new HAR viewer to sitespeed.io and help users to see how the requests are loaded. @@ -18,5 +20,8 @@ We use the ancient [BrowserMobProxy](https://github.com/lightbody/browsermob-pro ## Grunt/Gulp plugins Help us create a Grunt or Gulp plugin that runs sitespeed.io and integrates the performance budget functionality. -## Visual love for Hotlist -One new functionality released in 3.0 is the new ''Hotlist'' tab where we show things like slowest assets, largest images etc. That page result page need some love! +## Visual love for the Hotlist +One new functionality released in 3.0 is the new **Hotlist** tab where we show things like slowest assets, largest images etc. That page result page need some love! + +## New design for www.sitespeed.io +Today we use [Bootstrap](http://getbootstrap.com/) but we want to move away from it. We will start with the documentation site. Help make a super simple and light weight design for us. It needs to be simple and super fast :)