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.

Sign up for GitHub

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

docs: fix CONTRIBUTING.md phrasing #3477

Merged
merged 4 commits into from
Jul 13, 2024
Merged

docs: fix CONTRIBUTING.md phrasing #3477

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9cb3c71
docs: fix phrasing in in *Testing your Changes*
dangotbanned Jul 13, 2024
70264d2
docs: Use more consistent comments in *Failures on specific python ve…
dangotbanned Jul 13, 2024
d8d15fd
docs: wrap long line
dangotbanned Jul 13, 2024
8c57975
Merge branch 'main' into fix-contrib-typo
dangotbanned Jul 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ please read [the maintainers' notes](NOTES_FOR_MAINTAINERS.md).

### Testing your Changes

Before suggesting your contributing your changing to the main Altair repository,
Before submitting your changes to the main Altair repository,
it is recommended that you run the Altair test suite,
which includes a number of tests to validate the correctness of your code:

Expand All @@ -83,12 +83,13 @@ Study the output of any failed tests and try to fix the issues
before proceeding to the next section.

#### Failures on specific python version(s)
By default, `hatch test` will run the test suite against the currently active python version. Two useful variants for debugging failures that only appear *after* you've submitted your PR:
By default, `hatch test` will run the test suite against the currently active python version.
Two useful variants for debugging failures that only appear *after* you've submitted your PR:

```bash
# Test all environments in the matrix
# Test against all python version(s) in the matrix
hatch test --all
# The Python versions to test
# Test against a specific python version
hatch test --python 3.8
```

Expand Down