CONTRIBUTING.md

Contribution guidelines

Although life for Nazareth Recipes began as a humble repo, designed to store the recipes of meals cooked at the Nazareth Guesthouse, it is growing to become a place to store any communal recipe made by a member of Founders And Coders. We at Nazareth Recipes want to both embrace this bright new future, but also to remember and respect our past.

Thus, although only recipes cooked within a Founders And Coders community environment (most likely the Nazareth Guesthouse) will be merged into the repo, we would ❤️love❤️ to have more recipes avaliable and to encourage wider participation in this project.

So if you have a recipe that you think deserves to be on here, but you are unable to cook it at a communal event, please follow the exact same steps as below, but when making a pull request, the PR should have the Pending Cooking label attached to it. Once it has been cooked and eaten by members of the community, those lucky diners can then review and merge!*

• Before adding or editing a recipe
  • Labels
• Recipe Structure
  • Badges
• Pull requests
• Instructions for maintainers

Before adding or editing a recipe

1. Search this repo's issues to see if an issue exists for the recipe.
2. If the issue does not exist, create it.
3. If your new issue relates to any others, reference those issues in the body. This enables others to follow the history of the topic.
4. Assign the appropriate label. All recipe issues must have labels
5. Once you are sure of what you need to do and that it is needed, assign yourself to the issue.
6. Clone, and create a new branch for your work

Labels

Advice for labeling your recipes:

• Indicate what meal your recipe might apply to (breakfast, lunch or dinner) - it can apply to more than one.
• Indicate whether or not the meal is vegetarian friendly
• Add any other labels you feel might be appropriate.

Recipe Structure

You can use the following skeleton as a guide

# Name of Dish Here

- Badges here

**Head Chef:** 

**Sous Chef:** 

**Date Cooked:** 

**Number of servings:** 

**Author of Recipe:** 

## Ingredients
- Add all the ingredients here

## Preparation

1. Add step by step instructions here, ideally including photos of the process and/or finished product
2. etc

Photos of meal participants enjoying the food should come after the recipe

Badges

All recipes should have the following badges: Difficulty, Speed, Reception, Cost, Vegetarian, Vegan

Feel free to add other any badges you deem appropriate!

The badges can be contructed using the following url: https://img.shields.io/badge/<SUBJECT>-<STATUS>-<COLOUR>.svg (credit: https://shields.io/)

The subject should be one of the above, see directions below for status and colour guidance.

Difficulty

• STATUS: A percentage. Format should be the percentage number followed by %25
• COLOUR: One of 5 colours, corresponding to the status as follows:
  • 0-19% -brightgreen
  • 20-39% -green
  • 40-59% -yellow
  • 60-79% -orange
  • 80-100% -red

Speed

• STATUS: A time, in hours: 0.5hrs, 1hr, 1.5hrs
• COLOUR: One of 5 colours, corresponding to the status as follows:
  • < 0.5hrs -brightgreen
  • 0.5-0.9hrs -green
  • 1-1.4hrs -yellow
  • 1.5-1.9hrs -orange
  • 2hrs+ -red

Reception

• STATUS: A value: Very%20Negative, Negative, Ambivalent, Positive, Very%20Positive
• COLOUR: One of 5 colours, corresponding to the status as follows:
  • Very Postive -brightgreen
  • Postive -green
  • Ambivalent -yellow
  • Negative -orange
  • Very Negative -red

Cost

• STATUS: A value: Very%20Cheap, Cheap, Average, Expensive, Very%20Expensive
• COLOUR: One of 5 colours, corresponding to the status as follows:
  • Very Expensive -red
  • Expensive -orange
  • Average -yellow
  • Cheap -green
  • Very Cheap -brightgreen

Vegetarian

• STATUS: Boolean
• Colour: One of 2 colours:
• FALSE: red
• TRUE: brightgreen

Vegan

• STATUS: Boolean
• Colour: One of 2 colours:
• FALSE: red
• TRUE: brightgreen

Pull Requests

Once you have finished your work, push up your branch and make a pull request. Remember, a pull request should be as small as possible. This makes the review process quick and easy.

Make sure your PR has the following

1. A descriptive title - distinct from others and therefore searchable

2. A body with details of everything in the pull.

3. Reference to any/all related issues in description.

4. Assignees - add all the maintainers of nazareth-recipes to every PR: + @sofer + @mattlub + @m4v15 + @karyum

5. Reviewers + add anyone other than the maintainers, who you think should be aware of the recipe
   e.g. anyone else who ate the food, or has expressed an interest in knowing the recipe + if your PR requires a review from a particular person / people before it is ready to be merged, specify this within the body of your PR + Only maintainers should merge the PR's - if they are slacking, please feel free to give them a nudge in the comments of the PR.

6. If your recipe is yet to be cooked: Please give the PR a Pending Cooking label

Instructions for maintainers

Once a pull request has been reviewed by 3 people who ate the meal, as well as or including a maintainer, it can be merged. A PR should never be merged if a reviewer has requested changes and not yet re-reviewed it.

If a PR is up for an unreasonable amount of time without progress, maintainers should consult the creator on whether or not it will be finished at some point, and if not, close it.

If a PR has the Pending Cooking label attached, it can remain open indefinitely.

Maintainers should not merge their own PR's unless under extenuating circumstances and after discussion with others.

Thank you!

P.S. please star this repo ✨

* The reason for this seemingly ruthless rule is to ensure that a recipe is literally taste-tested before it is merged onto the repo - as per the Founders And Coders values, everything should be peer led and on a consensus basis, this rule helps to assure that for the recipes.