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
That's a very short section though and could be expanded a lot to explain how to do useful things with pytest using e.g. -nauto and --lf which are extremely useful options. It also does not explain how to run the doctests.
The old Wiki page for development has more information about running the tests and also mentions the idea of writing tests but doesn't really explain how to do it or show any examples: https://github.com/sympy/sympy/wiki/Development-workflow
There is no information anywhere about writing tests. Since this is a basic requirement for pretty much every PR it should be explained somewhere. In particular new contributors need to know the following things:
That pretty much every PR should have tests.
What the purpose of tests are in general.
How to run the tests locally and how to also interpret the CI output when tests fail.
Where to find the test code to look at it and also where to add more tests.
What sort of things should be tested.
How to write the tests and how to use things like raises etc.
That sometimes it is necessary to review or change the existing tests.
The text was updated successfully, but these errors were encountered:
I've just reviewed a number of recent open PRs and a common theme is new contributors not understanding what tests are or how to write them.
The contributing section of the docs mentions very briefly how to run the tests:
https://docs.sympy.org/latest/contributing/index.html#contributing
https://docs.sympy.org/latest/contributing/dev-setup.html#run-the-tests
That's a very short section though and could be expanded a lot to explain how to do useful things with pytest using e.g.
-nauto
and--lf
which are extremely useful options. It also does not explain how to run the doctests.The old Wiki page for development has more information about running the tests and also mentions the idea of writing tests but doesn't really explain how to do it or show any examples:
https://github.com/sympy/sympy/wiki/Development-workflow
There is no information anywhere about writing tests. Since this is a basic requirement for pretty much every PR it should be explained somewhere. In particular new contributors need to know the following things:
raises
etc.The text was updated successfully, but these errors were encountered: