From 68ee945029566c18c1817ad8c83b0bce1c656e37 Mon Sep 17 00:00:00 2001 From: Jasper van Merle Date: Wed, 21 Aug 2019 20:06:32 +0200 Subject: [PATCH] Process review comments --- .github/CONTRIBUTING.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 090b91cb..21c112bb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -69,7 +69,7 @@ Follow the following steps to update documentations to their latest version: 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. The `thor docs:generate` command outputs a summary of the changes, which helps identifying issues (e.g. deleted files) and new pages to check out in the app. Verify locally that everything works, especially the files that were created (if any), and that the categorization of entries is still good. Often, updates will require code changes in the scraper or it's filters to tweak some new markup in the source website or to categorize new entries. +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. `thor docs:generate` accepts a `--version` argument to specify which version to scrape. 8. Create a PR and make sure to fill the checklist in section B of the PR template (remove the other sections). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e37a76f8..5dc7eda4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -25,5 +25,7 @@ If you're updating an existing documentation to it's latest version, please ensu - [ ] Ensured the license is up-to-date and that the documentation's entry in the array in `about_tmpl.coffee` matches it's data in `self.attribution` - [ ] Ensured the icons and the `SOURCE` file in public/icons/*your_scraper_name*/ are up-to-date if the documentation has a custom icon - [ ] Ensured `self.links` contains up-to-date urls if `self.links` is defined -- [ ] Tested the changes locally to ensure the scraper still works without errors -- [ ] Tested the changes locally to ensure the scraped documentation still looks consistent with the rest of DevDocs and that the categorization of entries is still good +- [ ] Tested the changes locally to ensure: + - The scraper still works without errors + - The scraped documentation still looks consistent with the rest of DevDocs + - The categorization of entries is still good