Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to run tests #24

Closed
kevinhowbrook opened this issue May 10, 2022 · 3 comments
Closed

Document how to run tests #24

kevinhowbrook opened this issue May 10, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@kevinhowbrook
Copy link

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.

@kevinhowbrook kevinhowbrook added the documentation Improvements or additions to documentation label May 10, 2022
@zerolab
Copy link
Member

zerolab commented May 10, 2022

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
Copy link
Member

balazs-endresz commented Jun 29, 2022

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.

@kbayliss
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants