Skip to content
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

Docs: adjust wording in the contributing guide #213

Merged

Conversation

Arol15
Copy link
Contributor

@Arol15 Arol15 commented Jan 6, 2024

Description

Closes #209
This PR makes adjustments to some wording in the Contributing Guide:

  • Add this sentence as an opening line for the guide.

This Contributing Guide will walk you through how to contribute to this project for bug fixes and features. If you want to contribute to the guestbook, please refer to chapter five of the Intro to Open Source course.

  • Fix the wording of step 3 in the "Setup the Project Locally" as below:

Navigate to and open the project in your code editor.

  • Remove step 4 in the "Setup the Project Locally".

  • Update the numbering to reflect the changes in the Method 2 Section.

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

  • 🤝 Add a contributor
  • 📝 Documentation Update

Contributors checklist (check all applicable)

I've read through the Getting Started section.

  • ✅ Yes
  • ❌ Not yet

How did you add yourself as a contributor?

  • 🤖 With CLI
  • ⌨️ Manually

If you added yourself manually, did you follow the emoji key and contribution types to fill in the value?

  • ✅ Yes
  • ❌ No

Have you run npm run contributors:generate to generate your profile and the badge on the README?

  • ✅ Yes
  • ❌ No

Added to documentation?

  • 📜 README.md
  • 🙅 no documentation needed

Screenshot

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

GIF

@Arol15 Arol15 changed the title Docs: adjust wording in the contributing guide #209 Docs: adjust wording in the contributing guide Jan 6, 2024
CONTRIBUTING.md Show resolved Hide resolved
@Arol15 Arol15 marked this pull request as ready for review January 6, 2024 04:20
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, @Arol15! 🙌
Thank you for the PR! 😄

If you haven't, you can join our community Discord. 😊
Also, check out our pizza-verse repo if you want to contribute further! 🍕

git merge GIF

@adiati98 adiati98 merged commit 7f30c01 into open-sauced:main Jan 7, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Adjust wording in the Contributing Guide
2 participants