From 8666e31b5cb39b967dd43399213a454e7f106e9c Mon Sep 17 00:00:00 2001 From: Anmol Sethi <hi@nhooyr.io> Date: Wed, 4 Sep 2019 01:16:29 -0500 Subject: [PATCH] Cleanup docs further --- README.md | 2 +- docs/CONTRIBUTING.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57e3eff..93600f6 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ go get nhooyr.io/websocket ## Examples -For a production quality example that shows off the full API, see the [echo example on the godoc](https://godoc.org/nhooyr.io/websocket#example-package--Echo). On github, the example is at [./mod/example_echo_test.go](./mod/example_echo_test.go). +For a production quality example that shows off the full API, see the [echo example on the godoc](https://godoc.org/nhooyr.io/websocket#example-package--Echo). On github, the example is at [mod/example_echo_test.go](./mod/example_echo_test.go). Please use the [errors.As](https://golang.org/pkg/errors/#As) function [new in Go 1.13](https://golang.org/doc/go1.13#error_wrapping) to check for [websocket.CloseError](https://godoc.org/nhooyr.io/websocket#CloseError). See the [CloseError godoc example](https://godoc.org/nhooyr.io/websocket#example-CloseError). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3e5ef13..df79622 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -24,7 +24,9 @@ to an existing issue if one exists. In general, create an issue before a PR to g discussion going and to make sure you do not spend time on a PR that may be rejected. The Go module where development occurs is in the [mod](../mod) subpath so that the README.md -is immediately visible on the main page. +is immediately visible on the main page. I regularly clone the repo with mod as the root +to [nhooyr/websocket-mod](https://github.com/nhooyr/websocket-mod) so that all tooling works +normally. CI must pass on your changes for them to be merged. -- GitLab