From ef8de7646f2f8abb110acb95a5b7ac2e527a6fbf Mon Sep 17 00:00:00 2001 From: Mihai Todor Date: Mon, 9 Dec 2024 12:49:01 +0000 Subject: [PATCH] Update contributing guidelines Signed-off-by: Mihai Todor --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 18a916f356..ceb2f93cbb 100644 --- a/README.md +++ b/README.md @@ -170,7 +170,14 @@ docker run --rm \ ## Contributing -Contributions are welcome, please [read the guidelines](CONTRIBUTING.md). +Contributions are welcome! To prevent CI errors, please always make sure a pull request has been: + +- Unit tested with `make test` +- Linted with `make lint` +- Formatted with `make fmt` + +Note: most integration tests need to spin up Docker containers, so they are skipped by `make test`. You can trigger +them individually via `go test -run "^Test.*Integration.*$" ./internal/impl//...`. [inputs]: https://docs.redpanda.com/redpanda-connect/components/inputs/about [about-categories]: https://docs.redpanda.com/redpanda-connect/about#components