-
Notifications
You must be signed in to change notification settings - Fork 113
Home
If you want to help, you can do one of two things. (If you're feeling feisty, you can do both.)
-
Add a publisher. We want to have the most complete list of recipe publishers, so feel free add any recipe sites that we're missing. Please also add an issue and tag it
publisher. -
Claim a publisher. Claiming a publisher means you are taking responsibility for figuring out how to parse recipes from this particular publisher. You can find instructions on how to write a parser (spider) below.
Each publisher is a GitHub issue, so you can claim a publisher by claiming an issue. Claiming a publisher means you are taking responsibility for writing a simple parser for the recipes from this particular publisher. Our tech will store this in an object type based on the schema.org Recipe format, and can convert it into other formats for easy storage and discovery.
We're using the fork and pull development model for collaboration. Here are the steps you should follow for contributing code:
- Make an issue, or claim an issue, in the issue tracker
- Fork our repo, or make sure your existing fork is up to date
- Create a development branch for this issue
- Make your changes
- Create a pull request from your fork & branch
- Wait for feedback. We'll review your PR and either accept it, or make suggestions for improvement.
More reading: How to GitHub: Fork, Branch, Track, Squash and Pull Request
In order to be able to run your spider, you need to setup a dev environment.
Then, you can start writing your spider.
Under development, you might want to [test your spider] (https://github.com/fictivekin/openrecipes/wiki/Testing-your-spiders).
When you have a working spider, you contribute it to this project by submitting a Github pull request.
We'll use it to periodically bring recipe data into our database. The database will be available intially as data dumps.
Please feel free to dump links here for anything you think we should check out.