Make documentation great again

CHANGELOG.md

@@ -27,6 +27,7 @@ Versioning](http://semver.org/spec/v2.0.0.html) except to the first release.
 - Handle everything with `go test` (#115)
 - Use plain package instead of module for UUID submodule (#134)
 - Reset buffer if its average use size smaller than quater of capacity (#95)
+- Update API documentation: comments and examples (#123).
 
 ## [1.5] - 2019-12-29
 

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contribution Guide
+
+## First steps
+
+Clone the repository and install dependencies.
+
+```sh
+$ git clone [email protected]:/tarantool/go-tarantool
+$ cd go-tarantool
+$ go get .
+```
+
+## Running tests
+
+You need to [install Tarantool](https://tarantool.io/en/download/) to run tests.
+See the Installation section in the README for requirements.
+
+To install test dependencies (such as the
+[tarantool/queue](https://github.com/tarantool/queue) module), run:
+```bash
+make deps
+```
+
+To run tests for the main package and each subpackage:
+```bash
+make test
+```
+
+The tests set up all required `tarantool` processes before run and clean up
+afterwards.
+
+If you want to run the tests for a specific package:
+```bash
+make test-<SUBDIR>
+```
+For example, for running tests in `multi`, `uuid` and `main` packages, call
+```bash
+make test-multi test-uuid test-main
+```

LICENSE

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2014-2017, Tarantool AUTHORS
+Copyright (c) 2014-2022, Tarantool AUTHORS
 Copyright (c) 2014-2017, Dmitry Smal
 Copyright (c) 2014-2017, Yura Sokolov aka funny_falcon
 All rights reserved.

Makefile

@@ -12,8 +12,32 @@ deps: clean
 
 .PHONY: test
 test:
+	go test ./... -v -p 1
+
+.PHONY: test-multi
+test-multi:
+	@echo "Running tests in multiconnection package"
+	go clean -testcache
+	go test ./multi/ -v -p 1
+
+.PHONY: test-queue
+test-queue:
+	@echo "Running tests in queue package"
+	cd ./queue/ && tarantool -e "require('queue')"
+	go clean -testcache
+	go test ./queue/ -v -p 1
+
+.PHONY: test-uuid
+test-uuid:
+	@echo "Running tests in UUID package"
+	go clean -testcache
+	go test ./uuid/ -v -p 1
+
+.PHONY: test-main
+test-main:
+	@echo "Running tests in main package"
 	go clean -testcache
-	go test ./... -v -p 1	
+	go test . -v -p 1
 
 .PHONY: coverage
 coverage: