github.com/digitalocean/go-netbox@v0.0.2/CONTRIBUTING.md (about)

     1  Contributing
     2  ============
     3  
     4  The `go-netbox` project makes use of the [GitHub Flow](https://guides.github.com/introduction/flow/)
     5  for contributions.
     6  
     7  If you'd like to contribute to the project, please
     8  [open an issue](https://github.com/digitalocean/go-netbox/issues/new) or find an
     9  [existing issue](https://github.com/digitalocean/go-netbox/issues) that you'd like
    10  to take on.  This ensures that efforts are not duplicated, and that a new feature
    11  aligns with the focus of the rest of the repository.
    12  
    13  Once your suggestion has been submitted and discussed, please be sure that your
    14  code meets the following criteria:
    15    - code is completely `gofmt`'d
    16    - new features or codepaths have appropriate test coverage
    17    - `go test ./...` passes
    18    - `go vet ./...` passes
    19    - `golint ./...` returns no warnings, including documentation comment warnings
    20  
    21  In addition, if this is your first time contributing to the `go-netbox` project,
    22  add your name and email address to the
    23  [AUTHORS](https://github.com/digitalocean/go-netbox/blob/master/AUTHORS) file
    24  under the "Contributors" section using the format:
    25  `First Last <email@example.com>`.
    26  
    27  Finally, submit a pull request for review!