The Pizza Lovers Repository is a collaborative project where we can come together and contribute pizza-related content. Whether you have a fantastic pizza recipe, an interesting pizza fact, or just want to share your opinions on the best pizza toppings, this repository is the perfect place to do it!
You can now add a traditional food from your hometown or country to this repository, in addition to pizza!
Share your favorite pizza recipes. Whether it's a classic Margherita pizza or a unique creation of your own, this category aims to provide a variety of pizza recipes for everyone to enjoy. Contributors can share their recipes, including ingredients, cooking instructions, and other relevant details. Feel free to include images of your pizza creations to inspire others to try your recipes!
Share your interesting and informative pizza-related facts. Contributors can provide verified and accurate information about the history of pizza, trivia about different pizza styles, nutritional aspects, or any other factual details that enhance our understanding and appreciation of pizza. Whether it's uncovering the origins of a specific pizza topping or revealing fascinating facts about renowned pizzerias, this category aims to enlighten and educate pizza enthusiasts.
Share interesting and informative pizza-related facts about your hometown or country. You can provide verified and accurate information about its history of pizza, trivia about different pizza styles, nutritional aspects, or any other factual details that enhance our understanding and appreciation of pizza. Whether it's uncovering the origins of a specific pizza style, topping, or revealing fascinating facts about renowned pizzerias, this category aims to enlighten and educate pizza enthusiasts.
We love pizzas, but we also love any other food and adventure! Share the traditional food from your hometown or country with us! You can include its ingredients, culture, and interesting facts. Remember to show us a picture, too!
Important
We only receive one added item per file and one PR for each open issue (#32, #35, #36, and #86) per contributor.
So, you may add only one pizza recipe, one fact or trivia, one regional pizza, and one traditional food in separate PR based on the issue. If you want to add more than one, please open an issue and explain why we should add it.
Follow the steps below to get started:
- Fork this repository to your own GitHub account.
- Clone the forked repository to your local machine.
- Create a new branch with a name related to your contribution, for example,
feature/add-pizza-recipe. - You can now add a new pizza fact or trivia to the
pizza-facts-&-trivia.md, a new style of pizza to theregional-pizza.md, a new pizza recipe to thepizza-recipes.md, and a traditional food to theworld-traditional-food.mdfile. Remember, you may only submit one new item in a file. - Follow our
style-guide.mdto format your content. - Once you're done, add and commit your changes, then push them to your forked repository.
- Submit a pull request to have your contribution reviewed and considered for merging into the main repository.
- Engage with other contributors and maintainers through comments and discussions.
Merge conflicts occur when there are changes on the same line(s) in the same file(s) from two different branches. Since the main purpose in this repository is to add a new item to the pizza-facts-&-trivia.md, pizza-recipes.md, regional-pizza.md, and world-traditional-food.md files, there is a chance that you will encounter and need to resolve conflicts because maintainers might have merged PRs before yours while you're working on your changes or waiting for your PR to be reviewed.
In this section, we will walk you through how to keep your branch up to date and how to resolve conflicts.
Before resolving conflicts, your branch has to be in sync with the latest changes in the main branch of the original (upstream) repository.
First, you must update your forked (origin) repository:
- Go to your forked repository on GitHub.
- Click the "Sync fork" button.
- Click the green "Update branch" button.
Then, pull the latest changes in the main branch in the origin repository to your local working branch by following these steps in your terminal:
-
Go to your working branch.
git checkout <your-branch-name>
-
Pull the latest changes with this command:
git pull origin main
First, you need to pay attention to the conflicts. On which line(s) does the conflict happen? What are the differences?
Everything between the <<<<<<< HEAD and ======= is the changes that you worked on (current changes). And everything between the ======= to >>>>>>> is the incoming changes from the remote main branch that you have pulled.
Now, you must decide how you want to resolve the conflicts. Because the contributions in this repository are to add new items, you want to keep both yours and the incoming changes, which are the items from previous contributor(s).
Follow these steps to resolve the merge conflicts in this repository:
-
Click the "Accept Both Change" option on the top of your workspace in VSCode. If you haven't enabled this feature, check out this article by Lee Stanton to help you.
-
Fix anything necessary, such as duplicate sentences, etc. Tips: If you're confused, look at the markdown file in this repository to compare the current state of the content with your local file when fixing.
-
Move your item to the end of the list.
-
Add and commit your changes.
git commit -am "Resolve merge conflicts" -
Push your commits to your remote branch.
git push
All contributors are required to abide by our Code of Conduct.
- Keep the content relevant to each section.
- Ensure your content is family-friendly and suitable for all audiences.
- Provide credible sources for any facts or information you include.
- Respect our Code of Conduct and be kind and inclusive to others.
- Please check out the contributing guide for guidelines about how to proceed.
- We have a commit utility called @open-sauced/conventional-commit that helps you write your commits in a way that is easy to understand and process by others.
- Feel free to comment on and discuss other people's contributions, but keep the discussions constructive and respectful.
We encourage you to experiment, learn, and have fun while contributing to this repository! Let's celebrate the joy of pizza (and food!) together. 🎉
- Got Questions? Join the conversation in our Discord.
- Find OpenSauced videos and release overviews on our YouTube Channel.
MIT © OpenSauced