Skip to content

Commit b86ea2e

Browse files
authored
Update CONTRIBUTING.md
1 parent 6caa66a commit b86ea2e

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# CONTRIBUTING
22

3-
We use [go-swagger](https://github.com/go-swagger/go-swagger) to validate our spec against the 2.0 spec of Open API.
4-
5-
[We currently depend on version 0.18.0 of the go swagger toolchain. You can download the binary for your platform from this release page:
6-
7-
https://github.com/go-swagger/go-swagger/releases/tag/0.18.0](The go-client is an [netlify/open-api][open-api] derived http client generated using [go-swagger][go-swagger]. Starting with version [`2.0.0`](https://github.com/netlify/go-client/releases/tag/v2.0.0) it is managed with [Go 1.11 modules][go-modules], and all external tools used for generation are managed with [gobin][gobin] + Go modules. The [`swagger.yml`][swagger] is consumed as a vendored build-time asset via a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). See [GMBE:Tools as dependencies](https://github.com/go-modules-by-example/index/tree/master/010_tools) and [GMBE:Using `gobin` to install/run tools](https://github.com/go-modules-by-example/index/tree/master/017_using_gobin) for a deeper explanation.)
3+
The go-client is an [netlify/open-api][open-api] derived http client generated using [go-swagger][go-swagger]. Starting with version [`2.0.0`](https://github.com/netlify/go-client/releases/tag/v2.0.0) it is managed with [Go 1.11 modules][go-modules], and all external tools used for generation are managed with [gobin][gobin] + Go modules. The [`swagger.yml`][swagger] is consumed as a vendored build-time asset via a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). See [GMBE:Tools as dependencies](https://github.com/go-modules-by-example/index/tree/master/010_tools) and [GMBE:Using `gobin` to install/run tools](https://github.com/go-modules-by-example/index/tree/master/017_using_gobin) for a deeper explanation.)
84

95
## Spec validation
106

@@ -44,3 +40,19 @@ You may first want to edit swagger.yml to add your field or endpoint definitions
4440

4541
By contributing to Netlify Node Client, you agree that your contributions will be licensed
4642
under its [MIT license](LICENSE).
43+
44+
45+
46+
[godoc-img]: https://godoc.org/github.com/netlify/go-client/?status.svg
47+
[godoc]: https://godoc.org/github.com/netlify/go-client
48+
[goreport-img]: https://goreportcard.com/badge/github.com/netlify/go-client
49+
[goreport]: https://goreportcard.com/report/github.com/netlify/go-client
50+
[git-img]: https://img.shields.io/github/release/netlify/go-client.svg
51+
[git]: https://github.com/netlify/go-client/releases/latest
52+
[gobin]: https://github.com/myitcv/gobin
53+
[modules]: https://github.com/golang/go/wiki/Modules
54+
[open-api]: https://github.com/netlify/open-api
55+
[go-swagger]: https://github.com/go-swagger/go-swagger
56+
[go-modules]: https://github.com/golang/go/wiki/Modules
57+
[swagger]: https://github.com/netlify/open-api/blob/master/swagger.yml
58+

0 commit comments

Comments
 (0)