Skip to content

Commit

Permalink
Docs: Added prerequisites for argoCD, fork and clone repository, upst…
Browse files Browse the repository at this point in the history
…reaming, common make targets, steps before submitting a PR. (argoproj#20540)

Signed-off-by: Shubham Zanzad <shubhamzanzad25@gmail.com>
Co-authored-by: Dan Garfield <dan@codefresh.io>
  • Loading branch information
Shubhamzanzad and todaywasawesome authored Oct 30, 2024
1 parent bb1e75f commit d8fe100
Showing 1 changed file with 61 additions and 7 deletions.
68 changes: 61 additions & 7 deletions docs/developer-guide/contributors-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,49 @@ and the [toolchain guide](toolchain-guide.md).

## Getting Started

### Install Go
### Prerequisites

<https://go.dev/doc/install/>
Before starting, ensure you have the following tools installed with the specified minimum versions:

Install Go with a version equal to or greater than the version listed in `go.mod` (verify go version with `go version`).
* Git (v2.0.0+)
* Go (version specified in `go.mod` - check with `go version`)
* Docker (v20.10.0+) Or Podman (v3.0.0+)
* Kind (v0.11.0+) Or Minikube (v1.23.0+)
* Yarn (v1.22.0+)
* Goreman (latest version)

### Fork and Clone the Repository

### Clone the Argo CD repo
1. Fork the Argo CD repository to your personal Github Account

2. Clone the forked repository:
```shell
mkdir -p $GOPATH/src/github.com/argoproj/ &&
cd $GOPATH/src/github.com/argoproj &&
git clone https://github.com/argoproj/argo-cd.git
mkdir -p $GOPATH/src/github.com/argoproj/
cd $GOPATH/src/github.com/argoproj/
git clone https://github.com/YOUR-USERNAME/argo-cd.git
```

3. Add the upstream remote for rebasing:
```shell
cd argo-cd
git remote add upstream https://github.com/argoproj/argo-cd.git
```

### Install Required Tools

1. Install development tools:
```shell
make install-go-tools-local
make install-code-gen-tools-local
```

### Install Go

<https://go.dev/doc/install/>

Install Go with a version equal to or greater than the version listed in `go.mod` (verify go version with `go version`).


### Install Docker or Podman

#### Installation guide for docker:
Expand Down Expand Up @@ -103,8 +132,33 @@ DOCKER=podman make start-local ARGOCD_GPG_ENABLED=false
If the UI is not working, check the logs from `make start-local`. The logs are `DEBUG` level by default. If the logs are
too noisy to find the problem, try editing log levels for the commands in the `Procfile` in the root of the Argo CD repo.

## Common Make Targets

Here are some frequently used make targets:

* `make start-local` - Start Argo CD locally
* `make test` - Run unit tests
* `make test-e2e` - Run end-to-end tests
* `make lint` - Run linting
* `make serve-docs` - Serve documentation locally
* `make pre-commit-local` - Run pre-commit checks locally
* `make build` - Build Argo CD binaries

## Making Changes

### Before Submitting a PR

1. Rebase your branch against upstream main:
```shell
git fetch upstream
git rebase upstream/main
```

2. Run pre-commit checks:
```shell
make pre-commit-local
```

### Docs Changes

Modifying the docs auto-reloads the changes on the [documentation website](https://argo-cd.readthedocs.io/) that can be locally built using `make serve-docs` command.
Expand Down

0 comments on commit d8fe100

Please sign in to comment.