You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'd like to propose adding a new “Tests” section to the packaging guide that outlines best practices for writing clear, well-documented tests. This idea came up in a recent conversation pyOpenSci/software-peer-review#201, where we discussed the value of making tests easier for reviewers and contributors to understand.
Here’s what the new section could include:
Use of meaningful test names that reflect what is being tested
Docstrings or comments in test functions/modules that describe the purpose of the test
Clear test structure and organisation
Simple examples of good and bad test documentation practices
This would help both reviewers (who need to understand what’s being tested) and new contributors (who may want to add tests or debug).
Thanks to @ucodery for suggesting that I open this issue to get the conversation started.
Any comments or contributions are invited.