github.com/jduhamel/gcli@v0.2.4-0.20151019142748-0d5307cd7e21/skeleton/resource/tmpl/common/README.md.tmpl (about)

     1  # {{ .Name }}
     2  
     3  {{ .Description }}
     4  
     5  ## Description
     6  
     7  ## Usage
     8  
     9  ## Install
    10  
    11  To install, use `go get`:
    12  
    13  ```bash
    14  $ go get -d github.com/{{ .Owner }}/{{ .Name }}
    15  ```
    16  
    17  ## Contribution
    18  
    19  1. Fork ([https://github.com/{{ .Owner }}/{{ .Name }}/fork](https://github.com/{{ .Owner }}/{{ .Name }}/fork))
    20  1. Create a feature branch
    21  1. Commit your changes
    22  1. Rebase your local changes against the master branch
    23  1. Run test suite with the `go test ./...` command and confirm that it passes
    24  1. Run `gofmt -s`
    25  1. Create a new Pull Request
    26  
    27  ## Author
    28  
    29  [{{ .Owner }}](https://github.com/{{ .Owner }})