Skip to content

docs: add development prerequisites to contributing guide #4609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anaraydinli55 wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −4
Open

docs: add development prerequisites to contributing guide #4609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,17 @@ For significantly large and/or complex features, we may request that you write u

Please use the [template](/docs/adrs/yyyy-mm-dd-TEMPLATE) as guidance.

<!--
TODO: Add a pre-requisite section describing what developers should
install in order get started on ARC.
-->
## Prerequisites

To contribute to or build ARC locally, make sure you have the following tools installed:

- **Go**: Matching the version defined in `go.mod` (Go 1.22+ recommended).
- **Docker**: For building and packaging container images.
- **kubectl**: The Kubernetes command-line tool.
- **Helm 3**: For managing and packaging ARC Helm charts.
- **kind**: [Kubernetes IN Docker](https://kind.sigs.k8s.io/) for creating local test clusters.
- **setup-envtest**: Used for running integration tests locally (`go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest`).
- **golangci-lint**: For static code analysis and linting (`make lint`).

## How to Contribute a Patch

Expand Down