Skip to content

Commit

Permalink
docs: improve submission/PR info (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
jessicaschilling committed Oct 26, 2020
1 parent cc84899 commit a238f3f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 7 deletions.
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!--
Hello! To ensure this PR is correctly addressed as soon as possible by the IPFS team, please be sure of the following:
IF ADDING A NEW PUBLIC GATEWAY:
- Name your PR in the format `feat: add gateway.address.here`
- Make sure there is no trailing comma in the final gateway in the list at `gateways.json`
- Include a brief description of the gateway to be added (e.g. geographic location, connection speed, available space, etc)
ALL OTHER PULL REQUESTS:
- Name your PR in the format `feat: description`, `fix: description`, `docs: description`, `chore: description`, etc
- Be as complete in your description of changes as possible; if there is an impact on the UI, please include screenshots
- Reference any related issues
(you can delete this section after reading)
-->
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# ipfs/public-gateway-checker
# IPFS Public Gateway Checker

> Checks which public IPFS gateways are online or not.
**A site displaying public IPFS gateways and their online/offline status.**

You can view this website on GitHub Pages: https://ipfs.github.io/public-gateway-checker/
View the Public Gateway Checker on GitHub Pages: https://ipfs.github.io/public-gateway-checker/

[![screenshot_2020-01-05.png](https://gateway.ipfs.io/ipfs/Qma8nqj75L75aN3WpentAAEqyuEmwyrqUrX5yxAZV1Szma)](https://ipfs.github.io/public-gateway-checker/)
[![Screenshot of Public Gateway Checker](https://gateway.ipfs.io/ipfs/QmdRug9VoYcuaSC2c5KkJuxYfYNvUWdUdZhm5VmNimjfLd)](https://ipfs.github.io/public-gateway-checker/)

**NOTE:** All of these (except `ipfs.io` and `dweb.link`) are hosted by third-parties and should be treated as such.
**NOTE:** With the exception of `ipfs.io` and `dweb.link`, all gateways listed are hosted by third parties and should be treated as such.

## Adding a new public gateway

If you'd like to add a new public gateway, please edit `gateways.json` and submit a pull request.
If you'd like to add a new public gateway, please edit `gateways.json`:
1. Add the gateway's address to the bottom of the list
2. Make sure the final item in the list does **not** have a comma at the end, but all preceding items do

Then, submit a pull request for this change. Be sure to follow all the directions in the pull request template so your PR can be triaged as quickly as possible.

## Testing locally

Expand All @@ -20,4 +24,4 @@ $ npx http-server . -a 127.0.0.1 -p 3000 -c-1

## Command line

A CLI version `ipfg` is available here: https://github.com/JayBrown/Tools/tree/master/ipfg
Prefer to check public gateways from your terminal? A CLI version, `ipfg`, is available at https://github.com/JayBrown/Tools/tree/master/ipfg.

0 comments on commit a238f3f

Please sign in to comment.