icloud-photos-downloader/icloud_photos_downloader

Doc: Add guidelines for writing tests

Open

#230 opened on Nov 11, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (502 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (5,348 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

For developers joining the effort on icloudpd it would be beneficial to have a guideline on how to write test. Mentioned in #228

Contributor guide

Research direction
Explore the existing test files in the repository to understand the testing framework and conventions, then draft a guideline document covering how to write and run tests.
Tech stack
python
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonbasic testing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85