search

open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership
https://opensauced.pizza/learn
Other
503 stars 96 forks source link

feat: Add a contributing guide #53

Closed Lymah123 closed 9 months ago

Lymah123 commented 10 months ago

Description

This pull request makes the following changes:

Type of feature 🍕 Feature

Current behavior There's no contributing guide.

Suggested solution Since we've had some great contributions on this course and excitement around continued contributions, it's important to have a contributing guide specific to this repo. I'm thinking specifically about issue https://github.com/open-sauced/intro/issues/43, we could have better supported our contributor by ensuring they knew more.

We link to the main contributing guide from the docs, but we should add specifics for this repo:

how to add a new section, including conventions for numbering, the use of markdown, the need to add new sections to the sidebar. how to run the project locally. I suggest two methods: using the docsify CLI or using VS Code Go Live feature. how to add translations So I would suggest adding a contributing.md with a link to https://docs.opensauced.pizza/contributing/introduction-to-contributing/ followed by the specifics

What type of PR is this? (check all applicable)

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

Added to documentation?

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

netlify[bot] commented 10 months ago

Deploy Preview for sauced-intro ready!

Name Link
Latest commit c3b60ad3f7ed70d4568813051a9a50bec501c102
Latest deploy log https://app.netlify.com/sites/sauced-intro/deploys/6517430785c8c5000721f6f4
Deploy Preview https://deploy-preview-53--sauced-intro.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Lymah123 commented 10 months ago

@BekahHW , this is the new pull request I created for the contributing guide. I already linked the issue number in the repo. Let me know if this is exactly what you asked me to do.

Lymah123 commented 10 months ago

@CBID2 , this is the PR.

CBID2 commented 10 months ago

@CBID2 , this is the PR.

@Lymah123, these are the commits that you did for PR #44. I highly recommend closing this PR and waiting until that one is merged.

Lymah123 commented 10 months ago

Thank you @BekahHW and @CBID2 .

Lymah123 commented 9 months ago

Hi, @geoffreylgv. Thank you!

Great, I will include the links in the guide. Thanks for the suggestion.

CBID2 commented 9 months ago

@Lymah123, any updates on this?

Lymah123 commented 9 months ago

@Lymah123, any updates on this?

I have not gotten feedback from @BekahHW .

BekahHW commented 9 months ago

@Lymah123 did you add @geoffreylgv's suggestions?

@CBID2 does the translation section look good on your end?

Lymah123 commented 9 months ago

@Lymah123 did you add @geoffreylgv's suggestions?

@CBID2 does the translation section look good on your end?

Yes @BekahHW,I have added @geoffreylgv suggestions and @CBID2 has given her suggestions as well. I have worked on them all. If you can sill check again to be very sure all the necessary changes have been made.

geoffreylgv commented 9 months ago

@Lymah123 did you add @geoffreylgv's suggestions? @CBID2 does the translation section look good on your end?

Yes @BekahHW,I have added @geoffreylgv suggestions and @CBID2 has given her suggestions as well. I have worked on them all. If you can sill check again to be very sure all the necessary changes have been made.

Congratulations you all @Lymah123, @CBID2, @BekahHW 🥳

Lymah123 commented 9 months ago

LGTM

I am glad!

Thanks to y'all @BekahHW , @CBID2 and @geoffreylgv for your unwavering support.