ManimCommunity/manim

Update and improve documentation on tests

Open

#2,502 建立於 2022年1月28日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)Python (17,820 star) (1,378 fork)batch import
easyenhancementgood first issue

描述

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

貢獻者指南

技術棧
python
領域
documentationtesting
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Start by reading the current testing documentation at https://docs.manim.community/en/stable/contributing/testing.html. Identify missing sections about graphical unit tests and areas with awkward phrasing. Improve the content and structure without altering the underlying testing code. Since no maintainer clarification is needed, you can directly propose changes via a pull request.