ManimCommunity/manim

Update and improve documentation on tests

Open

#2,502 opened on Jan 28, 2022

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)Python (1,378 forks)batch import
easyenhancementgood first issue

Repository metrics

Stars
 (17,820 stars)
PR merge metrics
 (Avg merge 90d 10h) (31 merged PRs in 30d)

Description

Enhancement proposal

Our documentation on tests is slightly outdated (it does not mention graphical unit tests for video). In addition, the phrasing and grammar are awkward at many places and could do with a copyedit.

Additional comments

Contributor guide

Research direction
Review the current testing documentation, identify outdated sections regarding graphical unit tests, and improve phrasing and grammar.
Tech stack
python
Domain
documentation
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.
1-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85