open-sauced / intro

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

Feature: Changes need in "Let's Get Practical" section #120

Closed CBID2 closed 4 months ago

CBID2 commented 4 months ago

Type of feature

🍕 Feature

Current behavior

In the Let's Get Practical section, there have been two recurring themes when it comes to people completing the activity:

  1. Contributors using the CLI Tool method to submit their profile.
  2. Contributors are not running npm run contributors:addand npm run contributors:generatecommands to generate their profile in the guestbook.

After discussing this with @adiati98 and @BekahHW, we've realized that giving contributors the option to either use the CLI tool or manually adding themselves causes confusion.

Also, we want to make it clear that contributing to the pizza-verse repo is a good next step to practice contributing to open source.

Suggested solution

In the Getting Started subsection, do the following:

6. Run `npm run contributors: add` in your terminal. Follow the instructions to add yourself to the guestbook. After you finish and click enter, you must click enter again to confirm your choices

docs: add @your_username as a contributor

Then, press Q to run the log.

- [x]  Go to [step 11](https://github.com/open-sauced/intro/blob/4577a767191b640d3092b61a2c687c864fe96356/05-how-to-contribute-to-open-source.md?plain=1#L237C1-L241C7) and renumber it step 10:
  1. ​​ Push the commit to your forked repository with this command:
    git push -u origin branch-name
Congratulations on your first contribution! 🎉 If you're ready for your next contribution, head on over to the [pizza-verse repo](https://github.com/open-sauced/pizza-verse) and follow the contribution guidelines for your next contribution. Once you're done, head on over to chapter 6 in this course.

Additional context

No response

Code of Conduct

Contributing Docs

Pondy007 commented 4 months ago

.take

Pondy007 commented 4 months ago

Hi, I just submitted a PR for this issue. https://github.com/open-sauced/intro/pull/124