github.com/civo/civogo@v0.3.65/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  If you submit a pull request, please keep the following guidelines in mind:
     4  
     5  1. Code should be `go fmt` compliant.
     6  2. Types, structs and funcs should be documented.
     7  3. Tests pass.
     8  
     9  ## Getting set up
    10  
    11  Assuming your `$GOPATH` is set up according to your desires, run:
    12  
    13  ```sh
    14  go get github.com/civo/civogo
    15  ```
    16  
    17  If outside `$GOPATH`, just clone the repository:
    18  
    19  ```sh
    20  git clone https://github.com/civo/civogo
    21  ```
    22  
    23  ## Running tests
    24  
    25  When working on code in this repository, tests can be run via:
    26  
    27  ```sh
    28  go test .
    29  ```