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

Fix errors in CONTRIBUTING.md #221

Merged
merged 2 commits into from
Feb 28, 2025
Merged

Fix errors in CONTRIBUTING.md #221

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d701cb7
Fix errors in CONTRIBUTING.md
mhucka Feb 28, 2025
ddb78d7
Merge branch 'main' into mh-fix-contributing.md
mhucka Feb 28, 2025
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: 4 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,11 @@ Do your work and `git commit` your changes to your branch as needed.

We use several tools to test code and perform other activities such as checking
formatting against the style guidelines. You can run those tools locally during
development. Wrapper scripts are located in the [`check/`](./check/)
subdirectory to simplify running the tools.
development. Wrapper scripts are located in the [`dev_tools/`](./dev_tools/)
subdirectory to simplify running the tools with the correct configurations.

* Run `check/pytest` to run the Pytest suite
* Run `check/mypy` to run the Mypy type checker
* Run `check/pylint` to run the Pylint code linter
* Run `dev_tools/pylint` to run the Pylint code linter
* Run `dev_tools/nbfmt` to run the Jupyter Notebook format checker

### Pull requests and code reviews

Expand Down