From bd8f4e969fdc7156eb862ccdc746238d49e95a21 Mon Sep 17 00:00:00 2001 From: soulgalore Date: Tue, 27 Jan 2015 12:40:53 +0100 Subject: [PATCH] first commit [skip ci] --- HELP.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 HELP.md diff --git a/HELP.md b/HELP.md new file mode 100644 index 000000000..8251f85ef --- /dev/null +++ b/HELP.md @@ -0,0 +1,23 @@ +# Help +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. + +## 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. + +## Functionality 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 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. + +### A proxy producing HAR data +We use the ancient [BrowserMobProxy](https://github.com/lightbody/browsermob-proxy ) to get HAR files. It uses Java and there's work for modernizing the next version. But we would love to have a HAR proxy that is built in NodeJS. + +### 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!