Improve documentation

.travis.yml

@@ -43,6 +43,7 @@ script:
       bin/travis_scripts/check_docker.sh;
       bin/travis_scripts/check_docker_compose.sh;
 
+      # This checks requires development dependency
       bin/builder_run bin/check_lint
 
       # Run e2e tests on Pull Requests only

CONTRIBUTING.md

@@ -129,19 +129,19 @@ this PR will be merged into main branch.
 
 Before creating PR be sure to: 
 
-* **Step 1.** Ensure sure that **your** code quality is passing
+* **Step 1.** Ensure that **your** code quality is passing
 
 ```bash
 bin/check
 ```
 
-* **Step 2.** Ensure that all unit tests passes
+* **Step 2.** Ensure that all unit tests pass
 
 ```bash
 bin/test
 ```
 
-* **Step 3.** Ensure that all end-to-end tests passes
+* **Step 3.** Ensure that all end-to-end tests pass
 
 ```bash
 bin/test_e2e

bin/builder_docker/Dockerfile

@@ -7,7 +7,7 @@ RUN apt-get update \
     && gem install ffi -v 1.9.18 \
     && gem install fpm -v 1.9.3
 
-# Install development tools
+# Install development dependencies
 RUN go get \
     github.com/debber/debber-v0.3/cmd/debber \
     github.com/golang/lint/golint

bin/check

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-# Runs tests and code quality checks
+# Runs code quality checks
 #
 # Usage:
 #> bin/check

bin/check_fmt

@@ -3,7 +3,7 @@
 # Checks if all project files are formatted using go fmt
 #
 # Usage:
-#> bin/fmt
+#> bin/check_fmt
 
 source bin/helpers/output.sh
 

bin/check_lint

@@ -3,17 +3,18 @@
 # Run code Linter for project packages
 #
 # Usage:
-#> bin/lint [packages ...]
+#> bin/check_lint [packages ...]
 #
 # Examples:
-#> bin/lint
-#> bin/lint .
-#> bin/lint ./...
-#> bin/lint ./communication
-#> bin/lint ./communication/...
+#> bin/check_lint
+#> bin/check_lint .
+#> bin/check_lint ./...
+#> bin/check_lint ./communication
+#> bin/check_lint ./communication/...
 
 ARGUMENTS=$@
 if [ -z "$ARGUMENTS" ]; then
+    # By default, disable checks packages that are declared as not-cleared
     ARGUMENTS=`
         go list ./... \
         | grep -v "github.com/mysterium/node/cmd" \

bin/check_vet

@@ -3,14 +3,14 @@
 # Run Go vet command for project packages
 #
 # Usage:
-#> bin/vet [packages ...]
+#> bin/check_vet [packages ...]
 #
 # Examples:
-#> bin/vet
-#> bin/vet .
-#> bin/vet ./...
-#> bin/vet ./communication
-#> bin/vet ./communication/...
+#> bin/check_vet
+#> bin/check_vet .
+#> bin/check_vet ./...
+#> bin/check_vet ./communication
+#> bin/check_vet ./communication/...
 
 ARGUMENTS=$@
 if [ -z "$ARGUMENTS" ]; then