From 3c917ca703d1ca6339261a1c193c9b1f3e820d54 Mon Sep 17 00:00:00 2001 From: Peter Hedenskog Date: Wed, 26 Oct 2016 14:03:55 +0200 Subject: [PATCH] Updated for 4.0 --- HELP.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/HELP.md b/HELP.md index bbc8913a6..f6a9e999b 100644 --- a/HELP.md +++ b/HELP.md @@ -10,10 +10,10 @@ We would prefer that you spend your money on people that really needs it, suppor 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 suites you, take it on! If you want help to get started or want to discuss the solution, ping the issue and we can setup a hangout. ## Designers -Help us make the result pages look better! Help us make the documentation look better. You can pretty much help us with everything. +Help us make the result pages look better! Help us make the documentation look better [https://www.sitespeed.io](https://www.sitespeed.io). You can pretty much help us with everything := ## Documentation -Documentation is fun and it is the core of making software easy to use. Help us out and proof read and add sections that are missing. Documentation for 4.0 happens [here](https://github.com/sitespeedio/doc.sitespeed.io/tree/4.0). +Documentation is fun and it is the core of making software easy to use. Help us out and proof read and add sections that are missing. Documentation for 4.0 happens [here](https://github.com/sitespeedio/sitespeed.io/tree/master/docs). ## Tests We lack a lot of tests for the coming 4.0. Writing tests is a good way to get familiar with the codebase and will help us a lot in the future. A good start is adding support for the code in the [support library](https://github.com/sitespeedio/sitespeed.io/tree/master/lib/support). @@ -22,13 +22,10 @@ We lack a lot of tests for the coming 4.0. Writing tests is a good way to get fa ## 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. Pick one the things in the **Help wanted** section. Or maybe there's a function you think is missing? Create it. Contribute back. -# 4.0 a.k.a help wanted -There's a lot that needs to happen before we can release the final 4.0. +# Help wanted You can help us: * We want to be able to [blacklist/whitelist URLs](https://github.com/sitespeedio/browsertime/issues/156). If you do Python this could be your thing. * Do you use InfluxDB? @tobli did a POC implementing InfluxDB and you can [help us make it better](https://github.com/sitespeedio/sitespeed.io/issues/889). -* We need help with the documentation for 4.0. We have started in the [4.0 branch](https://github.com/sitespeedio/doc.sitespeed.io/tree/4.0) and would love to get feedback and help. -* We need [help](https://github.com/sitespeedio/sitespeed.io/issues/1089) with the [help text](https://github.com/sitespeedio/sitespeed.io/blob/master/lib/plugins/html/templates/help.pug) that explains the metrics we use. But can you understand the text? Help us make it understandable. -* [Make the tabs better (make the linkable)](https://github.com/sitespeedio/sitespeed.io/issues/1087). +* Help us make the documentation even better. We love your feedback and help [https://github.com/sitespeedio/sitespeed.io/tree/master/docs](https://github.com/sitespeedio/sitespeed.io/tree/master/docs). Checkout the [milestones](https://github.com/sitespeedio/sitespeed.io/milestones) and check if there's issues you want to do. Are they lacking info? Ping the issue and we will help you.