In the Let's Get Practical section, there have been two recurring themes when it comes to people completing the activity:
Contributors using the CLI Tool method to submit their profile.
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.
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
[x] Delete the instructions in Step 9 and replace them with the following statement:
9. Run `git log` to check if your changes have been automatically committed. Here's what you should expect to see as your commit message:
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:
Push the commit to your forked repository with this command:
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
[X] I agree to follow this project's Code of Conduct
Contributing Docs
[ ] I agree to follow this project's Contribution Docs
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:
npm run contributors:add
andnpm run contributors:generate
commands 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:
[x] Delete these lines: https://github.com/open-sauced/intro/blob/4577a767191b640d3092b61a2c687c864fe96356/05-how-to-contribute-to-open-source.md?plain=1#L149-L156
[ ] Delete the "Manual Addition" subsection in these lines:
https://github.com/open-sauced/intro/blob/26b19075ad266940e350eeba82e679f707d3ecec/05-how-to-contribute-to-open-source.md?plain=1#L162-L211
[x] Delete the instructions in Step 9 and replace them with the following statement:
docs: add @your_username as a contributor
Then, press
Q
to run the log.Additional context
No response
Code of Conduct
Contributing Docs