open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership

Home Page:https://opensauced.pizza/learn

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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:

  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:

  • 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:

    There are two ways you can complete this activity:
    - Using the CLI tool.
    - Manually editing the `.all-contributorsrc` file.
    Although adding yourself to the guestbook with the CLI tool is simpler, we recommend manually editing the file to get more experience adding and committing your changes, creating pull requests, and pull request reviews. Below, you'll find the directions for each method:
    **CLI Tool**

  • Delete the "Manual Addition" subsection in these lines:

    **Manual Addition**
    - Open the `.all-contributorsrc` file.
    - Go to the last contributor in the contributors' array.
    - Add a comma after the last closing curly bracket ( `},` ).
    - Copy and paste the template below:
    ```javascript
    {
    "login": "",
    "name": "",
    "avatar_url": "",
    "profile": "",
    "contributions": []
    }
    ```
    - Add yourself manually to the guestbook by updating this information:
    - **login**: Your GitHub's username.
    - **name**: Your name.
    - **avatar_url**: URL to your avatar on GitHub.
    In your browser, copy and paste the link of your GitHub profile, append `.png` at the end (for example, `https://github.com/USER_NAME.png`), and click enter. Copy and paste the link here.
    - **profile**: Link to your website (if you include it in your GitHub profile) **or** your GitHub profile.
    - **contribution**: Type of your contributions.
    Refer to the types (in the first column) in this [emoji key and contribution types](https://allcontributors.org/docs/en/emoji-key) to fill in the values.
    > ⚠️ **You have to strictly use the types in the list to avoid breaking the whole project.**
    The result would be like this:
    ```javascript
    {
    "login": "github-username",
    "name": "User Name",
    "avatar_url": "https://avatars.githubusercontent.com/u/xxxxxxxx?v=x",
    "profile": "URL link",
    "contributions": [
    "question",
    "blog",
    "code"
    ]
    }
    ```
    > ⚠️ **Remember to add a comma after the quotes, except for the last one in the array and the last closing curly bracket.**

  • 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
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

Hi, I just submitted a PR for this issue. #124