Skip to content

Docs: Add Development Guide to Contributing Guidelines#56

Open
angel1254mc wants to merge 1 commit intojadkins89:masterfrom
angel1254mc:angel1254mc/update-README-contributing-guide
Open

Docs: Add Development Guide to Contributing Guidelines#56
angel1254mc wants to merge 1 commit intojadkins89:masterfrom
angel1254mc:angel1254mc/update-README-contributing-guide

Conversation

@angel1254mc
Copy link

Hi! Thought this was a cool project and wanted to try and contribute to it 😄 I just added some README changes I thought would be useful to developers that are new to the codebase!

What this PR does

This PR adds a development guide to the contributing section of the README running through the steps needed to add a new Scraper to the library. This should hopefully help new contributors gain a footing with the codebase quickly, and make the task of adding a new scraper more straightfoward :)

I've also added some extra bits containing information about the Recipe Structured Data format that a couple of scrapers leverage already.

Open to any feedback and if you feel these changes are not necessary feel free to close :)

@angel1254mc angel1254mc changed the title Add Development Guide to Contributing Guidelines (README) Docs: Add Development Guide to Contributing Guidelines Oct 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant