Develop a scraper automating testing strategy/guidelines

Open
#44 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale

Research direction

Start by reviewing follow-up issue #43 and the regression causes identified here: coding errors and upstream changes. Establish and document a testing strategy and guidelines for scrapers, with clear approaches for reducing regression frequency and impact; completion should be an agreed set of standard practices.

Written by the indexing model from the issue text.

Description

question

Scrapers suffer regularly of regressions which take roots in:

  • Coding errors
  • Changing upstream

We have no clear strategy so far to reduce the number and impact of the regressions.

This issue is there to discuss how we could do better by raising standard approaches.

This issue is a follow-up of #43

Dominant language
HTML
Stars
12
Forks
3
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openzim/overview

All issues in openzim/overview

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.