Add docs for contributing, versioning and docs.

gilankpam · Mar 12, 2015 · 4df5360 · 4df5360
1 parent 66c450f
commit 4df5360
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# Contributing
+
+If you submit a pull request, please keep the following guidelines in mind:
+
+1. Code should be `go fmt` compliant.
+2. Types, structs and funcs should be documented.
+3. Tests pass.
+
+## Getting set up
+
+Assuming your `$GOPATH` is set up according to your desires, run:
+
+```sh
+go get github.com/digitalocean/godo
+```
+
+## Running tests
+
+When working on code in this repository, tests can be run via:
+
+```sh
+go test .
+```
diff --git a/README.md b/README.md
@@ -99,3 +99,25 @@ func DropletList(client *godo.Client) ([]godo.Droplet, error) {
     return list, nil
 }
 ```
+
+## Versioning
+
+Each version of the client is tagged and the version is updated accordingly.
+
+Since Go does not have a built-in versioning, a package management tool is
+recommended - a good one that works with git tags is
+[gopkg.in](http://labix.org/gopkg.in).
+
+To see the list of past versions, run `git tag`.
+
+
+## Documentation
+
+For a comprehensive list of examples, check out the [API documentation](https://developers.digitalocean.com/documentation/v2/).
+
+For details on all the functionality in this library, see the [GoDoc](http://godoc.org/github.com/digitalocean/godo) documentation.
+
+
+## Contributing
+
+We love pull requests! Please see the [contribution guidelines](CONTRIBUTING.md).