taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Update the CONTRIBUTING documentation to reflect reality

Browse Source
This commit is contained in:
Chris Cummer 2018-06-20 12:21:48 -07:00
parent 4094e033ce
commit bcc9b915cd
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -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 1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build. 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. 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 Documentation lives in the `_site` directory and is a [Hugo](https://gohugo.io).
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
## Code of Conduct ## Code of Conduct

3
README.md
View File

@ -32,6 +32,8 @@ documentation. Here's some short-cuts:
## Contributing ## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
### Adding Dependencies ### Adding Dependencies
Dependency management in WTF is handled by [dep](https://github.com/golang/dep). See that page for installation and usage details. 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 ## 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: Thanks goes to these wonderful people: