From bcc9b915cd944ba80999eea3f6d8ce85011e4979 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Wed, 20 Jun 2018 12:21:48 -0700 Subject: [PATCH] Update the CONTRIBUTING documentation to reflect reality --- CONTRIBUTING.md | 5 ++--- README.md | 3 ++- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc502913..95042292 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,10 +9,9 @@ Note that we have a code of conduct. Please follow it in all your interactions w 1. Ensure any install or build dependencies are removed before the end of the layer when doing a build. -2. Update the [README.md](README.md) with details of changes to the interface, this includes new environment +2. Update the static documentation with details of changes to the interface, this includes new environment variables, useful file locations and configuration parameters. -3. Increase the version numbers in any examples files and the [README.md](README.md) to the new version that this - Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +Documentation lives in the `_site` directory and is a [Hugo](https://gohugo.io). ## Code of Conduct diff --git a/README.md b/README.md index e31c0032..7870f5f0 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ documentation. Here's some short-cuts: ## Contributing +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests. + ### Adding Dependencies Dependency management in WTF is handled by [dep](https://github.com/golang/dep). See that page for installation and usage details. @@ -41,7 +43,6 @@ please be sure to use `dep` to [vendor your dependencies](https://golang.github. ## Contributors -Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests. Thanks goes to these wonderful people: