How to contribute cookbooks

At the moment this the first iteration of our Cookbook index, so we have bootstrapped a very simplified process. We plan to make the index more fully-featured and automated over time.

Add your own Cookbooks to the Index

To add your own cookbook to the index, follow these simple steps:

1. Fork this repository on your own GitHub account.
2. Create a new folder for your Cookbook in the recipes directory.
3. Copy your rules.sensei to your cookbook folder
4. Include a readme.md file alongside with your cookbook. This file should follow the guidelines described below:
   1. Create a pull request against our master branch.
   2. Our team will review it and approve as soon as possible.

Once approved, your Cookbook will be automatically parsed and published into the index repository.

Add Recipes to Existing Cookbooks

If there is a Cookbook in the listing that you believe you have a recipe that is a good fit, then:

1. If it is a GitHub hosted Cookbook then you can raise a pull request on the appropriate repo and add your recipe.
2. If it doesn't fit into any existing Cookbook then raise an issue with the recipe details, and potentially some example code that it matches and we'll create a Cookbook to add it to.
3. If it is for a download.zip only repo then raise an issue with the recipe details, and we'll add it to a Cookbook

Guidelines for your README.md file

Once a Cookbook is approved, an automated task will perform the analysis of your README.md file and include the minimum abstract to the main index. To avoid further issues, please ensure that it follow these simple rules:

• The first line should be the cookbook identification, prefixed with ##
• The following paragraph should contain a succinct explanation about your cookbook.
• Ensure that you have included at least one empty line before the first paragraph.
• Every other paragraph should be written using HTML syntax compatible with GitHub's flavoured markup.