-
Notifications
You must be signed in to change notification settings - Fork 208
docs(contributing): expand contribution guidelines with new sections #6399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
docs(contributing): expand contribution guidelines with new sections #6399
Conversation
…and details Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
eeshaanSA
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
@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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, @mohammedfirdouss.
Thanks a lot for your contributions! 🚀
Thank you for the reviews as well @eeshaanSA. Ready for more contributions! |
docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-to-pipecd.md
Show resolved
Hide resolved
Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can also change the file names to contributing-to-pipecd.md or something similar. contributing.md looks vague.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, this should be straightforward like you say but i feel the naming might be to long
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, you are right, but it is better to keep things clear, because we might need more pages here in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem, i have made a change to this effect.
Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
They should have similar structure now @eeshaanSA |
| ## 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! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @mohammedfirdouss, maybe you misunderstood the placement of Join the Community. Let's place it at the bottom end for both the files.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ohh!,apologies for that @eeshaanSA. Thanks!
Signed-off-by: Mohammed Firdous <mohammedfirdousaraoye@gmail.com>
eeshaanSA
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
|
@eeshaanSA In the meeting, Khan said I should rename the files, |
Addresses #6124