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 (5,348 stars) (502 forks)batch import
documentationhelp wanted

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

Tech stack
python
Domain
documentationtesting
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonpytestExisting test structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review existing tests in the repository, likely in a 'tests/' directory, and any prior discussion in issue #228. Identify common patterns and write a guidelines document covering test structure, naming conventions, and mocking strategies. Place the document in the docs/ or CONTRIBUTING.md file.
Doc: Add guidelines for writing tests · icloud-photos-downloader/icloud_photos_downloader#230 | Good First Issue