diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..a741ecef4 --- /dev/null +++ b/Makefile @@ -0,0 +1,10 @@ +.PHONY: pre-commit lint format + +pre-commit: + pre-commit run --all-files + +lint: + ruff check . + +format: + ruff format . diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f635b977f..16a8941ba 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -56,14 +56,11 @@ Use the gcloud credential helper as documented in the [Google Cloud documentatio ## Installation -If you have not installed the package and dependencies yet see [Installation](/README.md#installation). - +```md To use the development tools such as `pytest` or `pylint` use the `dev` option: ```bash pip3 install -e '.[dev]' -pre-commit install -``` To get an installation with the requirements for all workloads and development, use the argument `[full_dev]`.