Background

ArgoCD project has a contributor's quick guide documentation to help first time committers to get started with making changes in ArgoCD and be abe to create a Pull Request (PR) to the project. This documentation has scope for improvement and be enhanced to include some missing details.

Document to be updated

https://github.com/argoproj/argo-cd/blob/master/docs/developer-guide/contributors-quickstart.md

Approach

As you try setting a development environment, note down the steps that is actually required for the setup and note down the deviations in them. Those deviations can then be captured in this documentation.
Some of the missing pieces are.

• It talks about Docker based setup, similarly we can have a section for Podman based setup. ArgoCD make targets supports both Podman and Docker CLIs.
• Have a pre-requisites section, clearly mentioning the pre-requisites that needs to be installed in the laptop at the start. eg: git, golang, docker or podman, kind or minikube along with their min required versions
• The current instructions tells us to clone the repo directly. But instead it should be fork/clone process.
• There should be a step mentioning the command to add the remote upstream to rebase the feature branches.
• Some make targets available for installing the code-gen tools and go-tools (install-go-tools-local install-code-gen-tools-local) required to be run to install the tools required for the build process.
• A brief overview of the various make target commands can be mentioned.
• Before submitting the PR, one has to run the `make pre-commit-local` command to ensure that the liniting and other errors are validated locally before being pushed.