From e346b146427d013c5d138df8f56d6792b86006b1 Mon Sep 17 00:00:00 2001 From: Vincent Privat Date: Mon, 11 Aug 2025 13:36:00 +0200 Subject: [PATCH] Improve documentation how to run tests --- .github/pull_request_template.md | 2 +- CHANGES.md | 4 ++++ README.md | 9 +++------ 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 25ab1b0b8..3d3b575ed 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,6 +7,6 @@ **PR Checklist:** - [ ] `pre-commit` hooks pass locally -- [ ] Tests pass (run `make test`) +- [ ] Tests pass (run `make install test`) - [ ] Documentation has been updated to reflect changes, if applicable, and docs build successfully (run `make docs`) - [ ] Changes are added to the [CHANGELOG](https://github.com/stac-utils/stac-fastapi/blob/main/CHANGES.md). diff --git a/CHANGES.md b/CHANGES.md index d87de84bf..db6670143 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -2,6 +2,10 @@ ## [Unreleased] +### Changed + +- improved documentation how to run tests ([#851](https://github.com/stac-utils/stac-fastapi/pull/851)) + ## [6.0.0] - 2025-06-19 ### Changed diff --git a/README.md b/README.md index 580cadcfc..25dd84c18 100644 --- a/README.md +++ b/README.md @@ -78,16 +78,13 @@ Other backends may be available from other sources, search [PyPI](https://pypi.o Install the packages in editable mode: ```shell -python -m pip install \ - -e 'stac_fastapi/types[dev]' \ - -e 'stac_fastapi/api[dev]' \ - -e 'stac_fastapi/extensions[dev]' +make install ``` -To run the tests: +To run the tests (after the packages have been installed): ```shell -python -m pytest +make test ``` ## Releasing