Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 1.17 KB

contributing.md

File metadata and controls

27 lines (22 loc) · 1.17 KB

Contributing

The go-netbox project makes use of the GitHub Flow for contributions.

If you'd like to contribute to the project, please open an issue or find an existing issue that you'd like to take on. This ensures that efforts are not duplicated, and that a new feature aligns with the focus of the rest of the repository.

Once your suggestion has been submitted and discussed, please be sure that your code meets the following criteria:

  • code is completely gofmt'd
  • new features or codepaths have appropriate test coverage
  • go test ./... passes
  • go vet ./... passes
  • golint ./... returns no warnings, including documentation comment warnings

In addition, if this is your first time contributing to the go-netbox project, add your name and email address to the AUTHORS file under the "Contributors" section using the format: First Last <[email protected]>.

Finally, submit a pull request for review!