65350789e8
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> Co-authored-by: Nitish Kumar <justnitish06@gmail.com>
6.2 KiB
Overview
Warning
As an Argo CD user, you probably don't want to be reading this section of the docs.
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.
- A chat bot
- A Slack integration
Preface
Understand the Code Contribution Guide
Understand the Code Contribution Preface
Contributing to Argo CD documentation
This guide will help you get started quickly with contributing documentation changes, performing the minimum setup you'll need.
For backend and frontend contributions, that require a full building-testing-running-locally cycle, please refer to Contributing to Argo CD backend and frontend
Fork and clone Argo CD repository
Submit your PR
Contributing to Argo CD Notifications documentation
This guide will help you get started quickly with contributing documentation changes, performing the minimum setup you'll need.
The notifications docs are located in notifications-engine Git repository and require 2 pull requests: one for the notifications-engine repo and one for the argo-cd repo.
For backend and frontend contributions, that require a full building-testing-running-locally cycle, please refer to Contributing to Argo CD backend and frontend
Fork and clone Argo CD repository
Submit your PR to notifications-engine
Install Go on your machine
Submit your PR to argo-cd
- Contributing to notifications-engine
- Before submitting a PR
- Choose a correct title for your PR
- Perform the PR template checklist
Contributing to Argo CD backend and frontend
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.
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.
Set up your development environment
- Install required tools (Git, Go, Docker, etc)
- Install and start a local K8s cluster (Kind, Minikube or K3d)
- Fork and clone Argo CD repository
- Install additional required development tools
- Install latest Argo CD on your local cluster
Set up a development toolchain (local or virtualized)
-
Choose a development toolchain
Perform the development cycle
- Set kubectl context to argocd namespace
- Pull in all build dependencies
- Generate API glue code and other assets
- Build your code and run unit tests
- Lint your code base
- Run e2e tests
- How to contribute to documentation: build and run documentation site on your machine for manual testing
Run and debug Argo CD locally
Submit your PR
- Before submitting a PR
- Understand the Continuous Integration process
- Choose a correct title for your PR
- Perform the PR template checklist
- Understand the CI automated builds & tests
- Understand & make sure your PR meets the CI code test coverage requirements
Need help? Start with the Contributors FAQ
Contributing to Argo CD dependencies
Extensions and Third-Party Applications
Contributing to Argo Website
The Argo website is maintained in the argo-site repository.