Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

24 lines (19 loc) · 1.25 KB

Contributing

Thanks for checking out our recipe book! If you have an awesome recipe you'd like to share, please take a look at the guidelines and instructions for contributing below.

Guidelines

  • Cite your sources: attribute proper credits to the original authors of recipes you adapt
  • Append-only: please do not edit or remove recipes created by other people
  • Directory structure: place seasonal dishes in their respective subdirectories (e.g. fall, holiday, etc.)
  • File names: use underscores to denote the space character
  • Recommended sections (check out TEMPLATE.md for more details)
    • Ingredients
    • Instructions
    • Notes
    • Credits

Submitting a Pull Request

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-awesome-recipe
  3. Add your recipe using Markdown formatting
  4. Update the README.md located in your recipe's respective subdirectory
  5. Commit your changes: git commit -m "Add awesome-recipe"
  6. Push to your fork and submit a pull request