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

Add docs for how to run tests in development #1698

Merged
merged 4 commits into from
Mar 11, 2024
Merged

Conversation

joerick
Copy link
Contributor

@joerick joerick commented Dec 13, 2023

Ref #1687

Adding additional information about running tests. I've chosen to spell this out using a venv and pytest because I've found that I often want to use extra pytest options, like -k and --capture, not to mention the CIBW_PLATFORM variable, so it feels like it's not all that useful to make out that it's as easy as nox -s tests.

docs/contributing.md Outdated Show resolved Hide resolved
@joerick joerick marked this pull request as draft January 21, 2024 18:28
@joerick
Copy link
Contributor Author

joerick commented Jan 21, 2024

I'll take another look at this after #1727 is resolved.

@joerick
Copy link
Contributor Author

joerick commented Mar 2, 2024

Took another go at this. The diff's a bit of a mess - it's easier to read the rendered version: https://cibuildwheel--1698.org.readthedocs.build/en/1698/contributing/#development

@joerick joerick marked this pull request as ready for review March 2, 2024 19:58
@joerick
Copy link
Contributor Author

joerick commented Mar 9, 2024

@henryiii any input on this before it's merged? I've decided to go with nox as the primary way to document these, and since we don't need CIBW_PLATFORM any more, things are simpler generally. And, nox is gonna get much faster very soon :)

Once this one is merged, I'm keen to get a release out.

Copy link
Contributor

@henryiii henryiii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. A few things may update in the future (#1778 would make one part a lot simpler).

@henryiii henryiii merged commit 5c06f3c into main Mar 11, 2024
13 checks passed
@henryiii henryiii deleted the docs-contributing-tests branch March 11, 2024 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants