summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/unknwon/com/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/unknwon/com/README.md')
-rw-r--r--vendor/github.com/unknwon/com/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/vendor/github.com/unknwon/com/README.md b/vendor/github.com/unknwon/com/README.md
new file mode 100644
index 0000000000..da0a23bc99
--- /dev/null
+++ b/vendor/github.com/unknwon/com/README.md
@@ -0,0 +1,20 @@
+Common Functions
+================
+
+[![Build Status](https://travis-ci.org/unknwon/com.svg)](https://travis-ci.org/unknwon/com) [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/unknwon/com)
+
+This is an open source project for commonly used functions for the Go programming language.
+
+This package need >= **go 1.3**
+
+Code Convention: based on [Go Code Convention](https://github.com/unknwon/go-code-convention).
+
+## Contribute
+
+Your contribute is welcome, but you have to check following steps after you added some functions and commit them:
+
+1. Make sure you wrote user-friendly comments for **all functions** .
+2. Make sure you wrote test cases with any possible condition for **all functions** in file `*_test.go`.
+3. Make sure you wrote benchmarks for **all functions** in file `*_test.go`.
+4. Make sure you wrote useful examples for **all functions** in file `example_test.go`.
+5. Make sure you ran `go test` and got **PASS** .