docs(contributing): expand contribution guidelines with new sections by mohammedfirdouss · Pull Request #6399 · pipe-cd/pipecd

mohammedfirdouss · 2026-01-03T14:07:21Z

Expand contributing.md with community, dev setup, and PR process
Rename "Contributing" to "Contribute to PipeCD"
Apply changes to docs-dev and docs-v1.0.x

Addresses #6124

…and details Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

eeshaanSA

I checked the files, and while they look good, what do you think of making some more structural changes (better flow of data and sections), and also some more info on how to setup the a local dev guide? The reference to CONTRIBUTING.md is fine, but the CONTRIBUTING.md itself is outdated, so it is better to just have all the information in one page on the website.

mohammedfirdouss · 2026-01-04T08:30:36Z

Hey, thanks for this @mohammedfirdouss!

I checked the files, and while they look good, what do you think of making some more structural changes (better flow of data and sections), and also some more info on how to setup the a local dev guide? The reference to CONTRIBUTING.md is fine, but the CONTRIBUTING.md itself is outdated, so it is better to just have all the information in one page on the website.

Thanks for the feedback @eeshan! Hmm, Okay the website docs page should be self-contained rather than referencing CONTRIBUTING.md.

TO-DO

Better structured sections with clear flow
Complete local dev setup guide inline (Control Plane, Piped agent, port-forwarding, etc.)
Full PR process details instead of just linking to CONTRIBUTING.md

@eeshaanSA This should address the issue already yeah? I am open to feedbacks

…ty engagement details Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA

LGTM, @mohammedfirdouss.

Thanks a lot for your contributions! 🚀

mohammedfirdouss · 2026-01-05T08:58:46Z

LGTM, @mohammedfirdouss.

Thanks a lot for your contributions! 🚀

Thank you for the reviews as well @eeshaanSA. Ready for more contributions!

docs/content/en/docs-dev/contribution-guidelines/contributing.md

docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-to-pipecd.md

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA · 2026-01-08T08:57:43Z

docs/content/en/docs-dev/contribution-guidelines/contributing.md

We can also change the file names to contributing-to-pipecd.md or something similar. contributing.md looks vague.

Hmm, this should be straightforward like you say but i feel the naming might be to long

Yes, you are right, but it is better to keep things clear, because we might need more pages here in the future.

No problem, i have made a change to this effect.

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA · 2026-01-09T09:07:19Z

docs/content/en/docs-dev/contribution-guidelines/contributing.md

I might be nitpicking, but @mohammedfirdouss, what do you think about 'Join the Community' section being repositioned somewhere at the bottom? Would love to know your thoughts!

That makes sense to me. Moving Join the Community to the bottom should focus on how to contribute first, and people can find community links after.

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA

We can move "Join the Community"before "Whats next, in my opinion, and,

you changed only the docs-dev file. You forgot about v1.

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

mohammedfirdouss · 2026-01-11T08:24:48Z

We can move "Join the Community"before "Whats next, in my opinion, and,

you changed only the docs-dev file. You forgot about v1.

They should have similar structure now @eeshaanSA

eeshaanSA · 2026-01-12T09:30:00Z

docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-to-pipecd.md

+## What Happens Next?
+
+The maintainers will review your PR. We'll help with obvious issues and work with you to get it merged. Thank you for contributing!


Hey @mohammedfirdouss, maybe you misunderstood the placement of Join the Community. Let's place it at the bottom end for both the files.

Ohh!,apologies for that @eeshaanSA. Thanks!

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA

I think everything looks good now, @mohammedfirdouss. Thanks!

Let the maintainers merge, and then if we find anything later, we can change it.

mohammedfirdouss · 2026-01-13T23:40:17Z

I think everything looks good now, @mohammedfirdouss. Thanks!

Let the maintainers merge, and then if we find anything later, we can change it.

Alright @eeshaanSA. Thanks for the reviews!

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

mohammedfirdouss · 2026-01-15T14:04:07Z

@eeshaanSA In the meeting, Khan said I should rename the files, so docs/content/en/docs-dev/contribution-guidelines/contributing.md retains its name and the other goes to docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-to-pipecd.md

eeshaanSA

LGTM, thanks!

codecov · 2026-01-27T06:37:19Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 37.07%. Comparing base (41552f1) to head (a3c2b76).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6399      +/-   ##
==========================================
+ Coverage   28.79%   37.07%   +8.28%     
==========================================
  Files         557       75     -482     
  Lines       59769     6500   -53269     
==========================================
- Hits        17211     2410   -14801     
+ Misses      41246     3952   -37294     
+ Partials     1312      138    -1174

Flag	Coverage Δ
.	`?`
.-pkg-app-pipedv1-plugin-analysis	`32.64% <ø> (ø)`
.-pkg-app-pipedv1-plugin-kubernetes	`?`
.-pkg-app-pipedv1-plugin-kubernetes_multicluster	`?`
.-pkg-app-pipedv1-plugin-scriptrun	`54.83% <ø> (?)`
.-pkg-app-pipedv1-plugin-terraform	`38.65% <ø> (ø)`
.-pkg-app-pipedv1-plugin-wait	`33.92% <ø> (ø)`
.-pkg-app-pipedv1-plugin-waitapproval	`52.71% <ø> (ø)`
.-pkg-plugin-sdk	`50.34% <ø> (ø)`
.-tool-actions-gh-release	`19.23% <ø> (ø)`
.-tool-actions-plan-preview	`25.51% <ø> (ø)`
.-tool-codegen-protoc-gen-auth	`0.00% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

eeshaanSA

LGTM thanks!

docs(contributing): expand contribution guidelines with new sections …

4bfb0d8

…and details Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

Copilot AI review requested due to automatic review settings January 3, 2026 14:07

mohammedfirdouss requested a review from a team as a code owner January 3, 2026 14:07

mohammedfirdouss requested review from Warashi, khanhtc1202 and t-kikuc January 3, 2026 14:07

mohammedfirdouss mentioned this pull request Jan 3, 2026

[EPIC] Improve and Expand Contributing Section in Documentation #6124

Open

Copilot AI reviewed Jan 3, 2026

View reviewed changes

eeshaanSA reviewed Jan 3, 2026

View reviewed changes

docs: update contribution guidelines with Code of Conduct and communi…

5002f5a

…ty engagement details Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA approved these changes Jan 5, 2026

View reviewed changes

Merge branch 'master' into docs/expand-contributing-pipecd

61d153f

eeshaanSA added area/docs approved ready-to-merge PRs that are marked ready to merge by ORG Members and removed ready-to-merge PRs that are marked ready to merge by ORG Members labels Jan 7, 2026

mohammedfirdouss added 2 commits January 7, 2026 08:20

Merge branch 'master' into docs/expand-contributing-pipecd

56dec72

Merge branch 'master' into docs/expand-contributing-pipecd

43b940c

Ayushmore1214 reviewed Jan 7, 2026

View reviewed changes

docs/content/en/docs-dev/contribution-guidelines/contributing.md Show resolved Hide resolved

docs/content/en/docs-dev/contribution-guidelines/contributing.md Show resolved Hide resolved

docs/content/en/docs-dev/contribution-guidelines/contributing.md Show resolved Hide resolved

khanhtc1202 added approval-needed and removed approved labels Jan 8, 2026

eeshaanSA requested changes Jan 8, 2026

View reviewed changes

docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-to-pipecd.md Show resolved Hide resolved

mohammedfirdouss and others added 2 commits January 8, 2026 09:11

Merge branch 'master' into docs/expand-contributing-pipecd

ddf998c

Update contributing guidelines to include plugin configuration details

40fd9d4

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA requested changes Jan 8, 2026

View reviewed changes

eeshaanSA removed the approval-needed label Jan 8, 2026

Add contributing guidelines for PipeCD

9173fd3

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA reviewed Jan 9, 2026

View reviewed changes

Reorganize community contribution section in contributing guidelines

de0cfdd

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA requested changes Jan 10, 2026

View reviewed changes

Add community engagement section to contributing guidelines

ec13e54

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

Merge branch 'master' into docs/expand-contributing-pipecd

d862c95

eeshaanSA requested changes Jan 12, 2026

View reviewed changes

Reorganize community section in contributing guidelines

18547b8

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

eeshaanSA previously approved these changes Jan 13, 2026

View reviewed changes

eeshaanSA added the approval-needed label Jan 13, 2026

mohammedfirdouss and others added 2 commits January 14, 2026 00:40

Merge branch 'master' into docs/expand-contributing-pipecd

4515444

Add contributing guidelines for PipeCD

0e5e269

Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>

mohammedfirdouss dismissed eeshaanSA’s stale review via 0e5e269 January 15, 2026 14:02

Merge branch 'master' into docs/expand-contributing-pipecd

a3c2b76

eeshaanSA approved these changes Jan 27, 2026

View reviewed changes

Merge branch 'master' into docs/expand-contributing-pipecd

d4fbaa2

mohammedfirdouss requested a review from a team as a code owner January 27, 2026 08:53

Merge branch 'master' into docs/expand-contributing-pipecd

b067a05

eeshaanSA approved these changes Feb 2, 2026

View reviewed changes

Merge branch 'master' into docs/expand-contributing-pipecd

bdf2f47

eeshaanSA enabled auto-merge (squash) February 2, 2026 08:18

eeshaanSA merged commit 1c045f7 into pipe-cd:master Feb 2, 2026
42 checks passed

		## What Happens Next?

		The maintainers will review your PR. We'll help with obvious issues and work with you to get it merged. Thank you for contributing!

Conversation

mohammedfirdouss commented Jan 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

eeshaanSA left a comment

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TO-DO

Uh oh!

eeshaanSA left a comment

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss commented Jan 5, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eeshaanSA Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

eeshaanSA Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

eeshaanSA Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eeshaanSA left a comment

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss commented Jan 11, 2026

Uh oh!

eeshaanSA Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

eeshaanSA left a comment

Choose a reason for hiding this comment

Uh oh!

mohammedfirdouss commented Jan 13, 2026

Uh oh!

mohammedfirdouss commented Jan 15, 2026

Uh oh!

eeshaanSA left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

eeshaanSA left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mohammedfirdouss commented Jan 4, 2026 •

edited

Loading

mohammedfirdouss Jan 9, 2026 •

edited

Loading

codecov bot commented Jan 27, 2026 •

edited

Loading