Document how to run tests

Question

Document how to run tests

kevinhowbrook opened this issue 2 years ago · comments

I can see tox and coverage and a great suite of tests - would it be possible to document how to run the tests locally?

If I get some guidance here I'd be happy to make a PR myself for it. Also, I'd like to add the coverage report to the pipeline, and update contribution guidelines for checking tests are passing still.

Dan Braghiș · Answer 1 · Tue May 10 2022 18:26:16 GMT+0800 (China Standard Time)

https://github.com/torchbox/wagtailmedia#how-to-run-tests should give you an idea on running the tests.

https://github.com/wagtail/wagtail-localize/blob/main/.github/workflows/test.yml#L105 or https://github.com/torchbox/wagtailmedia/blob/main/.github/workflows/test.yml#L70 for coverage in CI

Balazs Endresz · Answer 2 · Wed Jun 29 2022 18:50:10 GMT+0800 (China Standard Time)

I couldn't get django-admin test or coverage or tox working locally but pytest does work. It's mentioned briefly here: https://github.com/torchbox/tbxforms/blob/main/CONTRIBUTING.md#publishing It might be better to add that to the readme instead.

Kyle Bayliss · Answer 3 · Wed Aug 16 2023 21:50:39 GMT+0800 (China Standard Time)

Documentation has now been added: https://github.com/torchbox/tbxforms/blob/main/CONTRIBUTING.md#python-testing