forked from sitespeedio/sitespeed.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d087751
commit a76b792
Showing
3 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# How to contribute | ||
Sitespeed.io continues to evolve thanks to people who contributes, so please please help out. Check our [list](HELP.md) of what you can do to help us. | ||
|
||
## Making changes | ||
If you want help out, that's great! Check the issue list and see if there's something there you want to do and drop me a note so I know and I can help you get into the project. | ||
|
||
## Add a defect | ||
Please make sure you run the [latest version](https://www.npmjs.com/package/sitespeed.io) of sitespeed.io. Then check the [defect/bug list](https://github.com/sitespeedio/sitespeed.io/issues?labels=bug&page=1&state=open) to make sure that it hasn't been filed yet. | ||
|
||
If you find a defect, please file a bug report. Include the following: | ||
- Explain the bug/defect and what you where doing. | ||
- OS & versions | ||
- Always add the URL of the page you where analyzing (if it is secret, drop me an email peter**at**soulgalore.com and send me the address). | ||
- Add a screenshot and clearly point out where the defect is (if applicable) | ||
- Include the content of the data/error.log file in a [gist](https://gist.github.com/) and attach it to the issue. | ||
|
||
If you have the skills & the time, it is perfect if you send a pull request with a fix, that helps us a lot! | ||
|
||
## Add a change request/new functionality request | ||
If you have an idea or something that you need sitespeed.io to handle, add an issue and lets discuss it there. Ideas/changes/requests are very very welcome! | ||
|
||
Thanks for your time & support! | ||
|
||
Peter & Tobias |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
Many many many thanks to: | ||
|
||
3.X and earlier: | ||
* Tom Sutton (@tomsutton1984) | ||
* Roberto Maisl (@rob-m) | ||
* Guillaume Lederrey (@gehel) | ||
* Tobias Lidskog (@tobli) | ||
* Emil Breding (@emilb) | ||
* Peter Van Gils (@kab12) | ||
* Juga Paazmaya (@paazmaya) | ||
* Ajay Jain | ||
* Andy Dawson (@AD7six) | ||
* Chris Southam (@ChrisSoutham) | ||
* JoongSeob Vito Kim (@dorajistyle) | ||
* Zack Tollman (@tollmanz) | ||
* Steffen Persch (@n3o77) | ||
* Matt Flower (@MattFlower) | ||
* Stefan Judis (@stefanjudis) | ||
* Peter Elmered (@pelmered) | ||
* Jeroen Van den Berghe (@JeroenVdb) | ||
* Eike (@EikeDawid) | ||
* Jesse Zoldak (@jzoldak) | ||
* Devrim Tufan (@tufandevrim) | ||
* Keith Cirkel (@keithamus) | ||
* Jonathan Lee (@beenanner) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# 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](https://github.com/sitespeedio/sitespeed.io/issues) that you want to help out, ping the issue and we'll help you 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. Pick one the things in the **Help wanted** section. Or maybe there's a function you think is missing? Create it. Contribute back. | ||
|
||
# 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. | ||
|
||
## 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. | ||
|
||
# Money | ||
> "Can't we just support you with money?" | ||
We would prefer that you spend your money on people that really needs it, support the [Red Cross](https://www.icrc.org/eng/donations/ways-to-donate/). If you represent a company and truly believe in Open Source, then you can sponsor the servers for [http://dashboard.sitespeed.io/](http://dashboard.sitespeed.io/). |