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

Jump to bottom

Update rules and steps to contribute in the README #54

Merged
merged 5 commits into from Oct 25, 2023
Merged

Update rules and steps to contribute in the README #54

merged 5 commits into from Oct 25, 2023
+129 −89

Conversation

adiati98
Copy link
Member

@adiati98 adiati98 commented Oct 24, 2023 •
edited

Description

This PR updates the rules and steps to contribute in the README with details as follow:

  • Added a rule for accepting only one added item per contributor.
  • Updated the steps to contribute.
    • Added a step to create a new branch.
    • Improved the wordings in step 4.
    • Added links for the GitHub and git commands.

This PR also updates:

  • The rule to use dash (-) instead of asterisks (*) for unordered list in the style-guide.md.
  • The unordered list in pizza-facts-&-trivia.md and regional-pizza.md by replacing asterisks with dashes.

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

Relates to #31

Mobile & Desktop Screenshots/Recordings

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

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?

there's still one more left GIF

@adiati98
Update rules and steps to contribute
5bd20b8 
Add a rule for only one item submission
* Add links and update the steps to contribute

Add links to the issues
@adiati98 adiati98 added documentation Improvements or additions to documentation 💡 feature labels Oct 24, 2023
@adiati98 adiati98 self-assigned this Oct 24, 2023
CBID2
CBID2 requested changes Oct 24, 2023
View reviewed changes
Copy link
Member

@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 @adiati98. You're off to a great start! 😊 I just gave some tips on how to tweak your PR.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@adiati98
Copy link
Member Author

@CBID2 done 😊

@adiati98
Update rules to use dash for ul in style-guide.md
ef72141 
* Change pizza fun facts ol to ul
* Change asterisks to dashes for ul in regional-pizza.md
@adiati98
Resolve conflicts
236256a
@adiati98
Change ol to ul in pizza trivia section
ee31ce5
CBID2
CBID2 approved these changes Oct 25, 2023
View reviewed changes
Copy link
Member

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

Looks great @adiati98! 😊 Merge time

@CBID2 CBID2 merged commit 18787b3 into open-sauced:main Oct 25, 2023
@adiati98 adiati98 deleted the docs/add-rules branch October 25, 2023 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CBID2 CBID2 CBID2 approved these changes

@BekahHW BekahHW Awaiting requested review from BekahHW

Assignees

@adiati98 adiati98

Labels
documentation Improvements or additions to documentation 💡 feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@adiati98 @CBID2