Update rules and steps to contribute in the README - Githubissues

open-sauced / pizza-verse

A repository for all things pizza.

MIT License

38 stars 56 forks source link

Update rules and steps to contribute in the README #54

Closed adiati98 closed 10 months ago

adiati98 commented 10 months ago

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
[x] 📝 Documentation Update
[ ] 🎨 Style
[ ] 🧑‍💻 Code Refactor
[ ] 🔥 Performance Improvements
[ ] ✅ Test
[ ] 🤖 Build
[ ] 🔁 CI
[ ] 📦 Chore (Release)
[ ] ⏩ Revert

Related Tickets & Documents

Closes #31

Mobile & Desktop Screenshots/Recordings

Added tests?

[ ] 👍 yes
[x] 🙅 no, because they aren't needed
[ ] 🙋 no, because I need help

Added to documentation?

[x] 📜 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 commented 10 months ago

@CBID2 done 😊