github.com/argoproj/argo-cd/v3@v3.2.1/docs/developer-guide/index.md (about)

     1  # Overview
     2  
     3  !!! warning "As an Argo CD user, you probably don't want to be reading this section of the docs."
     4      This part of the manual is aimed at helping people contribute to Argo CD, documentation, or to develop third-party applications that interact with Argo CD, e.g.
     5      
     6      * A chat bot
     7      * A Slack integration
     8  
     9  ## Preface
    10  #### Understand the [Code Contribution Guide](code-contributions.md)
    11  #### Understand the [Code Contribution Preface](submit-your-pr.md#preface)
    12      
    13  ## Contributing to Argo CD documentation
    14  
    15  This guide will help you get started quickly with contributing documentation changes, performing the minimum setup you'll need.   
    16  For backend and frontend contributions, that require a full building-testing-running-locally cycle, please refer to [Contributing to Argo CD backend and frontend ](index.md#contributing-to-argo-cd-backend-and-frontend) 
    17  
    18  ### Fork and clone Argo CD repository
    19  - [Fork and clone Argo CD repository](development-environment.md#fork-and-clone-the-repository)
    20  
    21  ### Submit your PR
    22  - [Before submitting a PR](submit-your-pr.md#before-submitting-a-pr)
    23  - [Choose a correct title for your PR](submit-your-pr.md#choose-a-correct-title-for-your-pr)
    24  - [Perform the PR template checklist](submit-your-pr.md#perform-the-PR-template-checklist)
    25  
    26  ## Contributing to Argo CD Notifications documentation
    27  
    28  This guide will help you get started quickly with contributing documentation changes, performing the minimum setup you'll need.
    29  The notificaions docs are located in [notifications-engine](https://github.com/argoproj/notifications-engine) Git repository and require 2 pull requests: one for the `notifications-engine` repo and one for the `argo-cd` repo.
    30  For backend and frontend contributions, that require a full building-testing-running-locally cycle, please refer to [Contributing to Argo CD backend and frontend ](index.md#contributing-to-argo-cd-backend-and-frontend) 
    31  
    32  ### Fork and clone Argo CD repository
    33  - [Fork and clone Argo CD repository](development-environment.md#fork-and-clone-the-repository)
    34  
    35  ### Submit your PR to notifications-engine
    36  - [Before submitting a PR](submit-your-pr.md#before-submitting-a-pr)
    37  - [Choose a correct title for your PR](submit-your-pr.md#choose-a-correct-title-for-your-pr)
    38  - [Perform the PR template checklist](submit-your-pr.md#perform-the-PR-template-checklist)
    39  
    40  ### Install Go on your machine
    41  - [Install Go](development-environment.md#install-go)
    42  
    43  ### Submit your PR to argo-cd
    44  - [Contributing to notifications-engine](dependencies.md#notifications-engine-githubcomargoprojnotifications-engine)
    45  - [Before submitting a PR](submit-your-pr.md#before-submitting-a-pr)
    46  - [Choose a correct title for your PR](submit-your-pr.md#choose-a-correct-title-for-your-pr)
    47  - [Perform the PR template checklist](submit-your-pr.md#perform-the-PR-template-checklist)
    48  
    49  ## Contributing to Argo CD backend and frontend 
    50  
    51  This guide will help you set up your build & test environment, so that you can start developing and testing bug fixes and feature enhancements without having to make too much effort in setting up a local toolchain.
    52  
    53  As is the case with the development process, this document is under constant change. If you notice any error, or if you think this document is out-of-date, or if you think it is missing something: Feel free to submit a PR or submit a bug to our GitHub issue tracker.
    54  
    55  ### Set up your development environment
    56  - [Install required tools (Git, Go, Docker, etc)](development-environment.md#install-required-tools)
    57  - [Install and start a local K8s cluster (Kind, Minikube or K3d)](development-environment.md#install-a-local-k8s-cluster)
    58  - [Fork and clone Argo CD repository](development-environment.md#fork-and-clone-the-repository)
    59  - [Install additional required development tools](development-environment.md#install-additional-required-development-tools)
    60  - [Install latest Argo CD on your local cluster](development-environment.md#install-latest-argo-cd-on-your-local-cluster)
    61  
    62  ### Set up a development toolchain (local or virtualized)
    63  - [Understand the differences between the toolchains](toolchain-guide.md#local-vs-virtualized-toolchain)
    64  - Choose a development toolchain
    65  
    66      - Either [set up a local toolchain](toolchain-guide.md#setting-up-a-local-toolchain)
    67      - Or [set up a virtualized toolchain](toolchain-guide.md#setting-up-a-virtualized-toolchain)
    68  
    69  ### Perform the development cycle 
    70  - [Set kubectl context to argocd namespace](development-cycle.md#set-kubectl-context-to-argocd-namespace)
    71  - [Pull in all build dependencies](development-cycle.md#pull-in-all-build-dependencies)
    72  - [Generate API glue code and other assets](development-cycle.md#generate-API-glue-code-and-other-assets)
    73  - [Build your code and run unit tests](development-cycle.md#build-your-code-and-run-unit-tests)
    74  - [Lint your code base](development-cycle.md#lint-your-code-base)
    75  - [Run e2e tests](development-cycle.md#run-end-to-end-tests)
    76  - How to contribute to documentation: [build and run documentation site](docs-site/) on your machine for manual testing
    77  
    78  ### Run and debug Argo CD locally
    79  - [Run Argo CD on your machine for manual testing](running-locally.md)
    80  - [Debug Argo CD in an IDE on your machine](debugging-locally.md)
    81    
    82  ### Submit your PR
    83  - [Before submitting a PR](submit-your-pr.md#before-submitting-a-pr)
    84  - [Understand the Continuous Integration process](submit-your-pr.md#understand-the-continuous-integration-process)
    85  - [Choose a correct title for your PR](submit-your-pr.md#choose-a-correct-title-for-your-pr)
    86  - [Perform the PR template checklist](submit-your-pr.md#perform-the-PR-template-checklist)
    87  - [Understand the CI automated builds & tests](submit-your-pr.md#automated-builds-&-tests)
    88  - [Understand & make sure your PR meets the CI code test coverage requirements](submit-your-pr.md#code-test-coverage)
    89  
    90  Need help? Start with the [Contributors FAQ](faq/)
    91  
    92  ## Contributing to Argo CD dependencies
    93  - [Contributing to argo-ui](dependencies.md#argo-ui-components-githubcomargoprojargo-ui)
    94  - [Contributing to gitops-engine](dependencies.md#gitops-engine-githubcomargoprojgitops-engine)
    95  - [Contributing to notifications-engine](dependencies.md#notifications-engine-githubcomargoprojnotifications-engine)
    96  
    97  ## Extensions and Third-Party Applications
    98  * [UI Extensions](extensions/ui-extensions.md)
    99  * [Proxy Extensions](extensions/proxy-extensions.md)
   100  * [Config Management Plugins](../operator-manual/config-management-plugins/)
   101  
   102  ## Contributing to Argo Website
   103  The Argo website is maintained in the [argo-site](https://github.com/argoproj/argo-site) repository.