README.md

The Events Calendar Team Cookbook

This is a collection of recipes and best practices for The Events Calendar team. It is a living document and will be updated as we learn and grow.

Contributing

Adding a new recipe

If you have a new recipe to add, please create a new branch and submit a pull request. If you are updating an existing recipe, please create a new branch and submit a pull request.

If you want to contribute a new recipe, follow the Adding a new recipe recipe.

Updating an exiting recipe

Existing recipes might contain errors, be out-of-date, or need to be improved.

If you see something that needs to be updated, follow the Updating a recipe recipe.

Table of Contents

• Caching
  • Whether to cache or not
  • Caching a value
• Database Queries
  • Find unbounded queries
  • Refactor unbounded query
  • Refactor unbounded TEC ORM query
  • Understand if a query is slow or fast
• Debug
  • Create throwaway plugin
• Recipes
  • Adding a new recipe
  • Updating a recipe