Giters

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: Making changes to directions in Let's Get Practical section

CBID2 opened this issue · comments

commented

Type of feature

🍕 Feature

Current behavior

For the activity in the Let's Get Practical section, there has been two recurring themes:

  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 come to the realization that giving contributors the option to either use the CLI tool or doing it manual is causing this confusion.

We also noticed that people are not contributing to the pizza-verse repo in spite of our promotion efforts, making it difficult for us to achieve OpenSauced's goal to create a contribution pathway for people to grow in their open source journey.

Suggested solution

For the first part of the issue, we having the following solution:

intro/05-how-to-contribute-to-open-source.md

Lines 162 to 211 in 4577a76

**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.**

  • Go to step 6:

    intro/05-how-to-contribute-to-open-source.md

    Line 147 in 4577a76

    6. Add yourself to the guestbook.

  • Replace it with the following statement:
    6. Add yourself to the guestbook with the CLI tool

  • Go to the next paragraph and delete it:

    intro/05-how-to-contribute-to-open-source.md

    Lines 149 to 156 in 4577a76

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

For the second half of the issue, do the following to add a section about our pizza-verse repo in the Let's Practical Section:

  • Go this line:

    intro/05-how-to-contribute-to-open-source.md

    Line 245 in 4577a76

    Congratulations on your first contribution! 🎉
  • Add the following statement next to it:
    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
commented

Hey @CBID2 can you link to the file and the line you're talking about?

Also, please include more info on pizza-verse as we discussed.

commented

Hey @CBID2 can you link to the file and the line you're talking about?

Also, please include more info on pizza-verse as we discussed.

Made the changes @BekahHW.

commented

Can you link to the file in the repo you want them to change rather than in the intro.OpenSauced.pizza site please?

commented

Can you link to the file in the repo you want them to change rather than in the intro.OpenSauced.pizza site please?

Done @BekahHW

commented

Let's make this more optional. Instead of suggesting:

Turn "Congratulations on your first contribution! 🎉" into "Yay you made it! 🎉" Now, you're ready for next contribution: Head on over to the pizza-verse repo and repeat the exact steps to make your contribution to this repository.

Let's do this

"Congratulations on your first contribution! 🎉 If you're ready for your next contribution, head on over to the pizza-verse repo and follow the contribution guidelines for your next contribution. Once you're done, head on over to chapter five in this course."

commented

Let's make this more optional. Instead of suggesting:

Turn "Congratulations on your first contribution! 🎉" into "Yay you made it! 🎉" Now, you're ready for next contribution: Head on over to the pizza-verse repo and repeat the exact steps to make your contribution to this repository.

Let's do this

"Congratulations on your first contribution! 🎉 If you're ready for your next contribution, head on over to the pizza-verse repo and follow the contribution guidelines for your next contribution. Once you're done, head on over to chapter five in this course."

Good idea! :)

commented

@CBID2 as this is a good first issue, can you please point both suggestions to the file and code snippet that need to be changed by creating a permalink?
This would make easier for first-time contributors to go to the exact file and line of codes.

See issue #107 for example.

commented

@CBID2 I'd say, instead of:

  1. Add yourself to the guestbook. Here’s how:
    Do 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.

Let's go with this:

  1. Add yourself to the guestbook with the CLI tool:

Then remove:

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

commented

@CBID2 I'd say, instead of:

  1. Add yourself to the guestbook. Here’s how:
    Do 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.

Let's go with this:

  1. Add yourself to the guestbook with the CLI tool:

Then remove:

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

Done @adiati98

commented

@CBID2 I'd say, instead of:

  1. Add yourself to the guestbook. Here’s how:
    Do 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.

Let's go with this:

  1. Add yourself to the guestbook with the CLI tool:

Then remove:

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

Done @adiati98

You haven't added the part that needs to be removed, @CBID2.

commented

@CBID2 I'd say, instead of:

  1. Add yourself to the guestbook. Here’s how:
    Do 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.

Let's go with this:

  1. Add yourself to the guestbook with the CLI tool:

Then remove:

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

Done @adiati98

You haven't added the part that needs to be removed, @CBID2.

I mentioned it in the second checkbox (it says “Delete the following information”). The lines are a permalink @adiati98

commented

@CBID2 that means we haven't removed the manual instruction.

  • There are two parts to be deleted:

    1. Paragraphs that need to be adjusted.

      intro/05-how-to-contribute-to-open-source.md

      Lines 149 to 156 in 4577a76

      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**
    2. Manual instruction

      intro/05-how-to-contribute-to-open-source.md

      Lines 162 to 211 in 4577a76

      **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.**

  • Looking closely to the instruction, I think step 9 and 10 also needs to be adjusted.

Can you please double check to what else need to be done here? In the meantime, I add the needs triage label until this is finalized. Thanks!

commented

When you're updating the info Ayu suggested, please update this link https://github.localhost/github.com/open-sauced/pizza-verse as well. It should be https://github.com/open-sauced/pizza-verse.

commented

@CBID2 that means we haven't removed the manual instruction.

  • There are two parts to be deleted:

    1. Paragraphs that need to be adjusted.

      intro/05-how-to-contribute-to-open-source.md

      Lines 149 to 156 in 4577a76

      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**
    2. Manual instruction

      intro/05-how-to-contribute-to-open-source.md

      Lines 162 to 211 in 4577a76

      **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.**

  • Looking closely to the instruction, I think step 9 and 10 also needs to be adjusted.

Can you please double check to what else need to be done here? In the meantime, I add the needs triage label until this is finalized. Thanks!

Hi @adiati98 steps 9 and 10 definitely need to be revised.

commented

Hi, I'm interested can i work on this issue?

commented

Hi, I'm interested can i work on this issue?

Hi @nickaldwin. I'm doing a better version of this issue, so I'm going to close this one. Be on the lookout for it.