Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.33 KB

Contributing guidelines

Issues

Before filing a new issue, check if it has already been reported and vote with a 👍 if it has. If the existing issue is a bug, and its description doesn't include your specific observed behavior or your environment, add a comment.

Feature requests:

  • please keep an eye on the issue after filing it as we will likely be reaching out with questions.

Bug reports:

  • try to come up with the simpliest case that illustrates the bug
  • provide as many details as possible:
    • expected result
    • observed result
    • your configuration
    • your environment (Kubernetes and NetBox versions)

Pull Requests

Before creating any pull requests, please file an issue: it will allow other users to track any known problems.

  • for any code changes, add unit tests or explain why they are not necessary
  • ensure your changes pass CI: if they don't, the PR will be considered incomplete and won't be reviewed
  • try to keep PRs small, if a large PR can be split into smaller ones, it's generally better to do so

k8s-env-test image

Note that new envtest images are automatically built and pushed to Docker Hub by the "build and release workflow", but this does not update the image used by integration tests. To do so, a new pull request must be opened to change the value of ENVTEST_DIGEST to the digest of the new image.