Giter VIP home page Giter VIP logo

pizza-verse's Introduction


Open Sauced

πŸ• Pizza Lovers Repository πŸ•

Welcome to OpenSauced's Pizza Lovers Repository!

Pizza Lovers Repository

Introduction

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!

Repository Structure

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!

How to Contribute

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:

  1. Fork this repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch with a name related to your contribution, for example, feature/add-pizza-recipe.
  4. You can now add a new pizza fact or trivia to the pizza-facts-&-trivia.md, a new style of pizza to the regional-pizza.md, a new pizza recipe to the pizza-recipes.md, and a traditional food to the world-traditional-food.md file. Remember, you may only submit one new item in a file.
  5. Follow our style-guide.md to format your content.
  6. Once you're done, add and commit your changes, then push them to your forked repository.
  7. Submit a pull request to have your contribution reviewed and considered for merging into the main repository.
  8. Engage with other contributors and maintainers through comments and discussions.

Keeping Branch Up to Date and Resolving Merge Conflicts

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.

Keeping Branch Up to Date

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:

  1. Go to your forked repository on GitHub.
  2. Click the "Sync fork" button.
  3. 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:

  1. Go to your working branch.

    git checkout <your-branch-name>
  2. Pull the latest changes with this command:

    git pull origin main

Resolving Merge Conflicts

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:

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

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

  3. Move your item to the end of the list.

  4. Add and commit your changes.

    git commit -am "Resolve merge conflicts"
  5. Push your commits to your remote branch.

    git push

Contribution Guidelines

All contributors are required to abide by our Code of Conduct.

To ensure a smooth and enjoyable experience for everyone, please adhere to the following guidelines when contributing to this repository:

  • 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. πŸŽ‰

πŸ• Community

  • Got questions? Join the conversation in our Community.
  • Find OpenSauced videos and release overviews on our YouTube Channel.

βš–οΈ LICENSE

MIT Β© OpenSauced

pizza-verse's People

Contributors

adiati98 avatar bekahhw avatar cbid2 avatar david-001 avatar devjster avatar emmarie-ahtunan avatar hikmahx avatar jdwilkin4 avatar kaz-smino avatar kenmusau avatar kumar007ambi avatar lymah123 avatar michaeljgoerlitz avatar michaella23 avatar mohdahsanrazakhan avatar mugabe000 avatar nickaldwin avatar nickytonline avatar pondy007 avatar prw760 avatar samuvelraja avatar satoshi-sh avatar sdp971 avatar silvia-wachira avatar sunny-unik avatar syke9p3 avatar the-techgurl avatar thititongumpun avatar twister904 avatar wheeleruniverse avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

pizza-verse's Issues

Feature: Add world's traditional foods

Suggested solution

Description

This repo is meant for our intro course participants to continue their learning by adding pizza-related information. Even though pizza is a favorite to most people, adding pizza-related information would be hard for folks who don't have interest in pizzas. We might want to add something else to this repo to spark interest for our course participants in continuing their learning.

Suggested Solution

Let's allow folks to add their favorite foods from their own countries! In international space, folks usually love to talk about their country, culture, and even their traditional foods. By allowing them to add this, we might be able to encourage folks to contribute further.

We will need:

  • A new file called world-traditional-foods.md.
  • An example in the file.
  • A new open issue.
  • Information about this addition in the README.
  • Update the PR template to include this addition.

Bug: I have a question regarding table of contents of recipes ?

Describe the bug

In the table of contents present 4 contents are available. Should the number of contents added for more added pizza recipes ?

Steps to reproduce

Add newly added recipes to the table contents.

Browsers

No response

Additional context (Is this in dev or production?)

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: Change in rules

Type of feature

πŸ• Feature

Current behavior

There have been concerns about merge conflicts occurring due to PRs with large numbers of content being added to the recipe and pizza-facts-and-trivia files

Suggested solution

  1. Add in new rules to the contributing guidelines section, such as "To keep things organized, You choose to either add one new pizza fact to the pizza-facts.md file or add one new recipe to the pizza-recipes.md file."
  2. Create a section that looks similar to the Resolving Conflicts section in the Contributing guide in the guestbook repository.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: I want to add some facts

Type of feature

πŸ• Feature

Current behavior

I want to some facts relate pizza to the under Fun-facts and trivia

Suggested solution

No response

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Bug: CODEOWNERS does not automatically add reviewers

Describe the bug

Currently, we have CODEOWNERS file that contains the list of code owners. But they don't get added automatically as reviewers as it suppposed to. And it happens because the syntax has to be on the same line.

Steps to reproduce

Can't be reproduced without a new incoming PR.

Browsers

No response

Additional context (Is this in dev or production?)

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: Add link to style guide in CONTRIBUTING File

Type of feature

πŸ“ Documentation

Current behavior

The repo's style guide has recently been merged, but contributors might wonder where to find it.

Suggested solution

Hyperlinking it to the Contributing guide would make it easier for them to find the style guide.

Additional context

I want to work on this issue

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: Update Nigerian Pizza description

Current behavior

Updated description of Nigerian Pizza to highlight its fusion of culinary traditions and diverse flavors

Suggested solution

No response

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Chores: Replace the logo in this repo's README

Important

If you've worked on a good first issue in any of our community repositories before, please refrain from taking this issue.
We may remove you from the assignees and not accept your pull request if you choose to proceed.

Description

Below logo in this repo's README is the old one, we should replace it with the new one.

Screenshot 2024-05-02 103453

Suggested Solution

Replace the logo by changing the link in the src with the below:

https://github.com/open-sauced/assets/blob/main/logos/logo-on-dark.png

Line to be changed:

<img alt="Open Sauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px">

docs: Grammar and Formatting issues

Type of feature

πŸ• Feature

Current behavior

The style guide has a few Markdown errors and grammar issues. This can make it difficult for people to implement the guidelines effectively when making their contribution to this project.

Suggested solution

  • Remove the gap in > ** Note:** Always check for spelling and grammar errors before you publish your PR. We highly recommend consulting [Grammarly](https://www.grammarly.com/) to help with any of your typos.. This would clarify to people that checking for spelling is needed when making their contribution.
  • Omit the word "to" in the sentence, Said images should be linked to using the following url: "https://raw.githubusercontent.com/open-sauced/pizza-verse/main/images/" followed by the image’s name. for clarity.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

README references non existent pizza, Facts and Recipes folders

In the README under the "How to Contribute" section, there are references to folders that are non existent in the repo.

The issue lies within steps 3-5 here:

  1. Inside the repository, navigate to the pizza folder.
  2. Choose an appropriate subfolder (e.g., Facts, Recipes) to add your content.
  3. Create a new markdown file in the chosen subfolder.

The repo currently does not have a pizza folder or Facts and Recipes subfolders.

Suggested fix

Add in the missing folders to the repo so contributors can add in their new recipes and pizza facts. πŸ‘

OR

If the goal is to have contributors directly edit the pizza-facts and pizza-recipes files, then I would suggest the following changes to the README.

  1. Fork this repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Add a new pizza fact to the pizza-facts.md file or choose to add a new recipe to the pizza-recipes.md file.
  4. Follow the existing markdown syntax to format your content. Feel free to add headings, bullet points, images, and links to enhance your contribution.
  5. Once you're done, commit your changes and push them to your forked repository.
  6. Submit a pull request to have your contribution reviewed and considered for merging into the main repository.
  7. Engage with other contributors and maintainers through comments and discussions.

Hope that helps πŸ˜„

Feature: I want to add a Pizza recipe

Type of feature

πŸ• Feature

Current behavior

I want to add a Indian Pizza Recipe which is quite popular in India.

Suggested solution

No response

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: Pizza education and learning resources

Type of feature

πŸ• Feature

Current behavior

  • There is no resources to learn pizza.

Suggested solution

  • Pizza-Making Courses and Workshops
  • Recommended Books and Documentaries
  • Online Pizza Communities and Forums

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: I want to add more pizza facts in Pizza Facts & Trivia

Type of feature

πŸ• Feature

Current behavior

I want to add more pizza facts in Pizza Facts & Trivia section for the information.

Suggested solution

No response

Additional context

I was wondering can admin add hactoberfest label or not ?

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: Enhanced description of Nigerian Pizza

Current behavior

Updated description of Nigerian Pizza to highlight its fusion of culinary traditions and diverse flavors

Suggested solution

No response

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Bug: Compliance action is not checking keywords "related to" and "relates to"

Describe the bug

This repo has open issues that we don't want to close. Therefore, we encourage contributors to use keywords of "Relates to" or "Related to" when link an issue in their PR. However, the action only checks default keywords. So, whenever an issue is linked with other keywords than the default ones, they won't pass the check as screenshot below.

Screenshot 2024-05-13 235220

Steps to reproduce

  1. Create a PR.
  2. Add "Relates to" keywords in front of an issue number when linking an issue.
  3. Issue check won't pass and the bot will warn about this.

Feature: Add a section for Regional Pizza

Type of feature

πŸ• Feature

Current behavior

We currently have categories for pizza recipes and facts. It would be nice for people to be able to add their regional pizza styles to this repo as well.

Suggested solution

  • Add a section for regional pizza styles in the readme that replicates facts and recipes
  • Create a regional-pizza.md file and replicate the organization of pizza-facts.md
  • remove the pizza styles section from the facts doc.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: Add compliance workflow to GitHub Action

Suggested solution

Currently, we have no GH action workflow applied in this repo to check if changes are made directly on default branch or if the title of a PR is following our convention.

Let's add the "Compliance" workflow. We can refer to the workflow in the hot repo and implement it here following what we have in the docs repo.

Feature: LICENSE this repo

Type of feature

πŸ• Feature

Current behavior

We need a license for this repo. My suggestion is MIT

Suggested solution

My suggestion is MIT

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Add pizza fact or trivia (Please Keep Open)

Do you have a favorite pizza fact or trivia? We'd love to hear it.

Before submitting, make sure the recipe doesn't already exist and then add one recipe to https://github.com/open-sauced/pizza-verse/blob/main/pizza-facts-%26-trivia.md.

Also, to keep this issue open, use "Relates to" when linking this issue to your PR in the "Related to" section of your PR template.

Feature: Add a PR template

Type of feature

πŸ• Feature

Current behavior

Currently, we're using the default PR template that lives in our .github repository for this repo.
However, there are some sections and points that aren't needed here, such as:

  • Mobile & Desktop Screenshots/Recordings
  • Added tests?
  • [optional] Are there any post-deployment tasks we need to perform?

Suggested solution

Based on the default template, create a PR template in the .github folder with related contents for this repo:

  • Remove the sections that are mentioned above.
  • Include only necessary items in the "What type of PR is this?" section as follow:
    • ☝️ Add a pizza fact or trivia
    • πŸ§‘β€πŸ³ Add a pizza recipe
    • πŸ—ΊοΈ Add a regional pizza
    • πŸ“ Documentation Update
  • Include only necessary items in the "Added to documentation?" section as follow:
    • πŸ“œ README.md
    • πŸ™… no documentation needed

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

feat: adding Zanzibar Pizza

Description

This PR adds Zanzibar Pizza to pizza-recipes.md

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

  • ☝️ Add a pizza fact or trivia
  • πŸ§‘β€πŸ³ Add a pizza recipe
  • πŸ—ΊοΈ Add a regional pizza
  • πŸ“ Documentation Update

Related Tickets & Documents

Related to #feat:

Added to documentation?

  • πŸ“œ README.md
  • πŸ™… no documentation needed

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

Add Regional pizza style to repo (Please Keep Open)

Do you have a regional-style pizza you want the world to know about? We'd love to hear it.

Before submitting, make sure the recipe doesn't already exist and then add one recipe to https://github.com/open-sauced/pizza-verse/blob/main/regional-pizza.md.

Also, to keep this issue open, use "Relates to" when linking this issue to your PR in the "Related to" section of your PR template.

Add a pizza Recipe! (Please Keep This Issue Open)

Do you have a favorite pizza recipe? We'd love to hear it.

Before submitting, make sure the recipe doesn't already exist and then add one recipe to https://github.com/open-sauced/pizza-verse/blob/main/pizza-recipes.md.

Also, to keep this issue open, use "Relates to" when linking this issue to your PR in the "Related to" section of your PR template.

Feature: add information about New York City Pizza to Regional Styles file

Type of feature

πŸ• Feature

Current behavior

Someone on X wanted to know if there are more styles of pizza besides Ohio Valley.

Suggested solution

Since New York City is often deemed the mecca of great pizza, I will add some information about this region's approach to pizza.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Feature: Markdown Style reference

Type of feature

πŸ“ Documentation

Current behavior

Even though the ReadMe file suggests following the markdown syntax based on the other entries, contributors, especially those who never used this language before would have a hard time remembering how to format their contribution.

Suggested solution

I think it would be helpful to create some sort of Markdown reference guide. It'll make it easier for contributors, especially those who have never used Markdown before to gain a better understanding of how to format their contribution.
Note: I would love to create this guide.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs

Add traditional food (Please Keep Open)

Do you have a favorite traditional food from your hometown or country? We'd love to hear it.

Before submitting, make sure the food doesn't already exist and then add one food to https://github.com/open-sauced/pizza-verse/blob/main/world-traditional-food.md. Please follow the instructions in the file's comment to add a food.

Also, to keep this issue open, use "Relates to" when linking this issue to your PR in the "Related Tickets & Documents" section of your PR template.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.