argo-cd icon indicating copy to clipboard operation
argo-cd copied to clipboard
verified publisher icon argoproj

docs: understand_the_basics.md with contribution guide

Open BHAVISHYA2005 opened this issue 7 months ago • 4 comments

This PR updates the documentation to improve clarity for new contributors. Key changes include:

  • Steps for running the project locally.
  • Guidance on signing off commits for DCO compliance.
  • Enhanced structure for the contribution guide.

Checklist:

  • [ X ] Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • [ X ] The title of the PR states what changed and the related issues number (used for the release note).
  • [ X ] The title of the PR conforms to the Toolchain Guide
  • [ Wasn't needed ] I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • [ ] I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • [ Yes ] Does this PR require documentation updates?
  • [ Yes ] I've updated documentation as required by this PR.
  • [ Yes ] I have signed off all my commits as required by DCO
  • [ Not Required ] I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • [ ] My build is green (troubleshooting builds).
  • [ ] My new feature complies with the feature status guidelines.
  • [x] I have added a brief description of why this PR is necessary and/or what this PR solves.
  • [ ] Optional. My organization is added to USERS.md.
  • [ ] Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

BHAVISHYA2005 avatar May 10 '25 13:05 BHAVISHYA2005

:x: Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • :rocket: /bns:deploy to deploy the environment

bunnyshell[bot] avatar May 10 '25 13:05 bunnyshell[bot]

I guess I need to redo all of this. Thanks for the feedbacks and mentioning the revisions

BHAVISHYA2005 avatar May 13 '25 10:05 BHAVISHYA2005

@BHAVISHYA2005 are you able to take this up?

If no, someone else can take this up or I'd rather do it as a part of this issue.

nitishfy avatar Jun 02 '25 11:06 nitishfy

Yeah you can take this issue & I think you can add more value. I am confused what to add and what not to ...

BHAVISHYA2005 avatar Jun 02 '25 13:06 BHAVISHYA2005

I would like to work on this

ishansaini194 avatar Jun 12 '25 16:06 ishansaini194

@ishansaini194 Please create a new issue for this and tag me on it.

nitishfy avatar Jun 13 '25 06:06 nitishfy