home
  • Blog
1.12
  • Getting Started
  • Concepts
  • The Object Model
  • Application
  • Templates
  • Routing
  • Components
  • Controllers
  • Models
  • Views
  • Enumerables
  • Testing
  • Configuring Ember.js
  • Ember Inspector
  • Cookbook
    • Introduction
    • Contributing
      • Introduction
      • Understanding the Cookbook Format
      • Participating If You Know Ember
      • Participating If You Don't Know Ember
      • Deciding If A Recipe is a Good Fit
      • Suggesting A Recipe
    • User Interface and Interaction
    • Event Handling & Data Binding
    • Helpers & Components
    • Working with Objects
  • Understanding Ember.js
  • Contributing to Ember.js
Old Guides - You are viewing the guides for Ember v1.12.0.
Go to v5.0.0

Understanding the Cookbook Format

Edit pencil

Problem

You want to contribute, but aren't familiar with the Cookbook format or don't know how your contribution should be formatted.

Solution

Cookbook-style guides contain recipes that guide a beginning programmer to a deeper knowledge of the subject by answering specific, "how-to" style questions. Cookbook recipes address more topics than API documentation for a class, but are smaller in scope than a topic-based guide.

All recipes follow the same format:

Title
Broadly explains the topic of the recipe
Problem
Outlines the recipe's goals
Solution
Summarizes the correct approach to addressing the problem
Discussion
Explores the solution in detail

A Cookbook does not need to be read in any particular order, and each recipe should contain all the information necessary for a beginner to address the problem statement. Referring to other recipes that are considered prerequisite knowledge is encouraged.

Discussion

Take a look at an O'Reilly Cookbook or the Coffeescript Cookbook. Both of these are great examples of the Cookbook format.

left arrow
Introduction
Participating If You Know Ember
right arrow
On this page

  • Problem
  • Solution
  • Discussion
Team Sponsors Security Legal Branding Community Guidelines
Twitter GitHub Discord Mastodon

If you want help you can contact us by email, open an issue, or get realtime help by joining the Ember Discord.

© Copyright 2023 - Tilde Inc.
Ember.js is free, open source and always will be.


Ember is generously supported by
blue