Skip to content

Commit a238f3f

Browse files
docs: improve submission/PR info (#119)
1 parent cc84899 commit a238f3f

File tree

2 files changed

+26
-7
lines changed

2 files changed

+26
-7
lines changed

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!--
2+
Hello! To ensure this PR is correctly addressed as soon as possible by the IPFS team, please be sure of the following:
3+
4+
IF ADDING A NEW PUBLIC GATEWAY:
5+
- Name your PR in the format `feat: add gateway.address.here`
6+
- Make sure there is no trailing comma in the final gateway in the list at `gateways.json`
7+
- Include a brief description of the gateway to be added (e.g. geographic location, connection speed, available space, etc)
8+
9+
ALL OTHER PULL REQUESTS:
10+
- Name your PR in the format `feat: description`, `fix: description`, `docs: description`, `chore: description`, etc
11+
- Be as complete in your description of changes as possible; if there is an impact on the UI, please include screenshots
12+
- Reference any related issues
13+
14+
(you can delete this section after reading)
15+
-->

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
1-
# ipfs/public-gateway-checker
1+
# IPFS Public Gateway Checker
22

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

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

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

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

1111
## Adding a new public gateway
1212

13-
If you'd like to add a new public gateway, please edit `gateways.json` and submit a pull request.
13+
If you'd like to add a new public gateway, please edit `gateways.json`:
14+
1. Add the gateway's address to the bottom of the list
15+
2. Make sure the final item in the list does **not** have a comma at the end, but all preceding items do
16+
17+
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.
1418

1519
## Testing locally
1620

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

2125
## Command line
2226

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

0 commit comments

Comments
 (0)