pipe-cd / pipe-cd/pipecd

Video for Contributor Overview Guide: Architecture & PR Workflow

Open
#6,488 15 comments 0 reactions 1 assignee View on GitHub

@Ayushmore1214 is already working on this.

Since Jan 31, 2026.

Dominant language
Go
Stars
1.4k
Forks
364
Avg merge
1d 4h
Merged PRs (30d)
84

Description

Following the discussion in Slack, I’d like to work on a comprehensive Contributor Overview Guide video (approx. 10 mins) , this video will focus on the "what, where, and how" of the PipeCD codebase to help new contributors ship their first PR with confidence.

The Overview :

  • How PipeCD works (The simple version): A quick look at the architecture—basically how the Control Plane talks to the Piped agents.

  • Where’s the code?: A tour of the folders so people aren't clicking around aimlessly. I’ll show where the core logic lives vs the frontend stuff.

  • Actually contributing: * Where to talk to the team (Slack/GitHub) before you start.

  • How to run tests locally so you don't break things.

  • What to expect during a code review and how to handle feedback.

@eeshaanSA let me know what you think. If there’s anything specific you find yourself explaining over and over to new people, tell me and I’ll make sure it’s in the video and I am open for feedbacks so i can include in this video , on what do you didn't understand about the project while you were a new comer , I'll include it in the vid!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.