Feature: Changes need in "Let's Get Practical" section
CBID2 opened this issue Β· comments
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:
- Contributors using the CLI Tool method to submit their profile.
- Contributors are not running
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:
- Change the wording in Step 6 to this:
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
-
Delete these lines:
intro/05-how-to-contribute-to-open-source.md
Lines 149 to 156 in 4577a76
-
Delete the "Manual Addition" subsection in these lines:
intro/05-how-to-contribute-to-open-source.md
Lines 162 to 211 in 26b1907
-
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.
- Go to step 11 and renumber it step 10:
10. ββ Push the commit to your forked repository with this command:
```bash
git push -u origin branch-name
- To solve the second part of this issue, make the following change to the last sentence of the exercise:
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
- I agree to follow this project's Code of Conduct
Contributing Docs
- I agree to follow this project's Contribution Docs
.take
Hi, I just submitted a PR for this issue. #124