From e9bc16c25e7c0c5ddaac0af340cdea4e12b008e2 Mon Sep 17 00:00:00 2001 From: Jed Fox Date: Mon, 2 Jan 2023 15:56:44 -0500 Subject: [PATCH] Link to the instructions for obtaining file scraper data from the contributing docs --- .github/CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 69585211..2922dcf0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -67,10 +67,11 @@ Follow the following steps to update documentations to their latest version: 2. Check if the license is still correct. If you update `options[:attribution]`, also update the documentation's entry in the array in [`assets/javascripts/templates/pages/about_tmpl.coffee`](../assets/javascripts/templates/pages/about_tmpl.coffee) to match. 3. If the documentation has a custom icon, ensure the icons in public/icons/*your_scraper_name*/ are up-to-date. If you pull the updated icon from a place different than the one specified in the `SOURCE` file, make sure to replace the old link with the new one. 4. If `self.links` is defined, check if the urls are still correct. -5. Generate the docs using `thor docs:generate `. -6. Make sure `thor docs:generate` doesn't show errors and that the documentation still works well. Verify locally that everything works and that the categorization of entries is still good. Often, updates will require code changes in the scraper or its filters to tweak some new markup in the source website or to categorize new entries. -7. Repeat steps 5 and 6 for all versions that you updated. -8. Create a PR and make sure to fill the checklist in section B of the PR template (remove the other sections). +5. If the scraper inherits from `FileScraper` rather than `URLScraper`, follow the instructions for that scraper in [`file-scrapers.md`](../docs/file-scrapers.md) to obtain the source material for the scraper. +6. Generate the docs using `thor docs:generate `. +7. Make sure `thor docs:generate` doesn't show errors and that the documentation still works well. Verify locally that everything works and that the categorization of entries is still good. Often, updates will require code changes in the scraper or its filters to tweak some new markup in the source website or to categorize new entries. +8. Repeat steps 5 and 6 for all versions that you updated. +9. Create a PR and make sure to fill the checklist in section B of the PR template (remove the other sections). ## Coding conventions