Skip to content

docs: add prerequisite/setup guide to CONTRIBUTING.md#6507

Open
cheese-cakee wants to merge 6 commits intopipe-cd:masterfrom
cheese-cakee:docs/add-prerequisites
Open

docs: add prerequisite/setup guide to CONTRIBUTING.md#6507
cheese-cakee wants to merge 6 commits intopipe-cd:masterfrom
cheese-cakee:docs/add-prerequisites

Conversation

@cheese-cakee
Copy link
Copy Markdown
Contributor

What this PR does:
Adds a 'Step 0: Prerequisites' section to CONTRIBUTING.md listing Go, Docker, Make, etc.

Why we need it:
To help new contributors set up their environment faster.

Which issue(s) this PR fixes:
Fixes #6482

Does this PR introduce a user-facing change?:

  • How are users affected by this change: Better onboarding docs.
  • Is this breaking change: No
  • How to migrate (if breaking change): N/A

@cheese-cakee cheese-cakee requested a review from a team as a code owner February 3, 2026 21:33
Signed-off-by: cheese-cakee <farzanaman99@gmail.com>
@cheese-cakee cheese-cakee force-pushed the docs/add-prerequisites branch from 9dae650 to 0d380c4 Compare February 12, 2026 11:13
@cheese-cakee
Copy link
Copy Markdown
Contributor Author

Thanks for the review @Ayushmore1214! All suggestions addressed in the latest force-push:

  • Renamed Step 0: PrerequisitesPrerequisites to match the document structure
  • Fixed the YAML code fence to close with 4 backticks (matching its opening)
  • Fixed the bash code fence to close with 3 backticks (matching its opening)
  • Fixed the confiurationconfiguration typo

@cheese-cakee
Copy link
Copy Markdown
Contributor Author

Hi @Ayushmore1214, all suggestions from your review have been addressed in the latest push. Would appreciate a re-review when available. Thank you!

@Warashi Warashi requested a review from a team as a code owner March 14, 2026 04:30
@cheese-cakee
Copy link
Copy Markdown
Contributor Author

Closing as this has been open for 2 months with no progress despite addressing all feedback. Happy to reopen if a maintainer has bandwidth to review.

@eeshaanSA eeshaanSA reopened this Apr 3, 2026
@eeshaanSA
Copy link
Copy Markdown
Contributor

@cheese-cakee, apologies, maintainers have full times jobs apart from the project, and it can really get busy sometimes. Please feel free to discuss the issue in the community meetings, public slack channels – before closing PRs.

eeshaanSA
eeshaanSA previously approved these changes Apr 3, 2026
Copy link
Copy Markdown
Contributor

@eeshaanSA eeshaanSA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks, there is a similar page on our documentation website, please feel free to open PRs to make changes there as well.

@eeshaanSA
Copy link
Copy Markdown
Contributor

@cheese-cakee please resolve conflicts.

@eeshaanSA eeshaanSA enabled auto-merge (squash) April 3, 2026 20:46
@eeshaanSA eeshaanSA disabled auto-merge April 3, 2026 20:46
Signed-off-by: Cheese Cake <farzanaman99@gmail.com>
@cheese-cakee
Copy link
Copy Markdown
Contributor Author

@cheese-cakee please resolve conflicts.

done

@cheese-cakee
Copy link
Copy Markdown
Contributor Author

@cheese-cakee, apologies, maintainers have full times jobs apart from the project, and it can really get busy sometimes. Please feel free to discuss the issue in the community meetings, public slack channels – before closing PRs.

thankyou, will keep that in mind

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The first contributions workflow should be revamped

4 participants