Skip to content

Upd feat 120 #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 26, 2024
Merged

Upd feat 120 #124

merged 7 commits into from
Feb 26, 2024

Conversation

Pondy007
Copy link
Contributor

@Pondy007 Pondy007 commented Feb 23, 2024

Description

This PR fixes the feature #120.

Solution implemented :
In the Getting Started subsection, I did the following:

  • Change the wording in Step 6 to this:
  1. 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:
Lines 149 to 156 in [4577a76](https://github.com/open-sauced/intro/commit/4577a767191b640d3092b61a2c687c864fe96356)

 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 instructions in Step 9 and replace them with the following statement:
  1. 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

  • Go to step 12 and renumber it step 11

  • To solve the second part of this issue, I made 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 and follow the contribution guidelines for your next contribution. Once you're done, head on over to chapter 6 in this course.

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Closes #120

Mobile & Desktop Screenshots/Recordings

image
image

Steps to QA

  1. Go to the Let's get practical section
  2. In the Getting Started subsection, check steps 6 to 11
  3. Check the last sentence of this section

Added to documentation?

  • 📜 README.md
  • 📓 docs.opensauced.pizza
  • 🍕 dev.to/opensauced
  • 📕 storybook
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

😊

Vivine and others added 2 commits February 22, 2024 14:21
… to avoid confusion between CLI tool and manual

*docs: change wording in step 6
*docs: delete lines 149 to 156
*docs: delete step 9 and reword step 10
*docs: renumber steps from 9 to 11
*docs: add link to the pizza-verse repo as a good next step to practice contributing to open source.
Copy link

netlify bot commented Feb 23, 2024

Deploy Preview for sauced-intro ready!

Name Link
🔨 Latest commit 7375013
🔍 Latest deploy log https://app.netlify.com/sites/sauced-intro/deploys/65dca13024162a0008a3205e
😎 Deploy Preview https://deploy-preview-124--sauced-intro.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Comment on lines 150 to 151
**Manual Addition**

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Pondy007. This part needs to be omitted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. Done : line "Manual Addition" removed.

Copy link
Contributor

@CBID2 CBID2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Pondy007. So far, your PR looks good. You just need to omit a section before I give another review.

@CBID2 CBID2 added the documentation Improvements or additions to documentation label Feb 23, 2024
@Pondy007 Pondy007 requested a review from CBID2 February 24, 2024 09:19
Copy link
Member

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Pondy007,

First of all, thank you for the PR and the prompt changes! Really appreciate it. ✨

Our intention in this issue is to remove the "Manual Addition" part as we will go for adding contributors with the CLI only.

So, from our side, we apologize that we missed to include an instruction to remove the subsection and clarify the wording adjustment accordingly that cause this kind of long review. 🙏

  1. I've updated the issue to include removing the "Manual Addition" subsection. It's the one that I haven't checked.

  2. After you done that, I've also left reviews here for you to fix.

Please let me know if you have questions or any help by tagging me here.

Thank you. 😊

@Pondy007
Copy link
Contributor Author

Hi,
I made all requested changes. I still did not find how to allow some indentation in VSCode when saving. So I modified through github and it's ok now (and get the file to VSCode with proper indentation). New preview is the following.

image

@Pondy007 Pondy007 requested a review from adiati98 February 25, 2024 09:41
Copy link
Member

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done, @Pondy007! 🙌
Thank you for the changes! 😄

For your future reference, once you've fixed something from the suggestions, you can click the resolve button.
Doing this can help you and the maintainer to check which suggestion are done, and which are still need to be fixed.

git merge GIF

@adiati98
Copy link
Member

adiati98 commented Feb 26, 2024

I still did not find how to allow some indentation in VSCode when saving.

This mostly happens because there's a Markdown extension or feature enabled in your VS Code, which is good.

One trick that helps is when you need to indent a line for one tab, click tab 2 times, then save it. It will save the correct format of the indentation.

But there are some cases where this trick won't work, for example when creating directory tree in Markdown.
In this case, commit and push the changes without saving it.

Hope this helps 😊

Copy link
Contributor

@CBID2 CBID2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done @Pondy007! :) Thanks for contributing! :)

@CBID2 CBID2 merged commit e870023 into open-sauced:main Feb 26, 2024
@Pondy007
Copy link
Contributor Author

Thanks a lot @adiati98 for your advices. I did not know the use of Resolve button.
And for the tips ;-)
Thanks both of you @adiati98 and @CBID2 for your time and review ! It really was a first good issue !
Have a nice day !

@Pondy007 Pondy007 deleted the upd-feat-120 branch February 26, 2024 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Changes need in "Let's Get Practical" section
3 participants