diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 686e365..9e0a9e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,14 @@ A ready-to-use [dev container](.devcontainer/) is provided with the Go toolchain Docker-in-Docker, and the recommended VS Code extensions. Opening the repository in a supporting editor is the quickest way to get a consistent environment. +Everyday commands: + +```sh +make test # unit tests (Ginkgo + Gomega) +make lint # golangci-lint +make docker-build # build the container image +``` + ## Architecture The project uses a clean-architecture layering with an inward-only dependency @@ -50,6 +58,12 @@ owns its responsibility: - Make sure `go test ./...` and `golangci-lint run` pass before opening a PR, and keep PRs focused. +## Reporting issues + +Use GitHub issues to report bugs or request features. Before opening one, search the existing +issues to avoid duplicates, and include enough context to reproduce: the version or commit, the +environment, the steps you took, and the expected versus actual behavior. + ## Keep the docs in sync Treat the docs as part of the change, not an afterthought. In the same PR: diff --git a/README.md b/README.md index c6c2972..a3a8445 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # nodeip-discovery +[![Post Merge](https://github.com/scality/nodeip-discovery/actions/workflows/post-merge.yaml/badge.svg)](https://github.com/scality/nodeip-discovery/actions/workflows/post-merge.yaml) +[![GitHub release](https://img.shields.io/github/v/release/scality/nodeip-discovery)](https://github.com/scality/nodeip-discovery/releases/latest) +[![Go version](https://img.shields.io/github/go-mod/go-version/scality/nodeip-discovery)](go.mod) +[![License](https://img.shields.io/github/license/scality/nodeip-discovery)](LICENSE) + A Kubernetes node-level agent that discovers the local network interfaces of the node it runs on, filters their IPv4 addresses against a configured set of CIDRs and a given list of excluded IPs and writes the result to a node annotation.