Skip to content

docs: add local test data setup step #523

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

Open
samay2504 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add local test data setup step #523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,23 @@ Thank you for your interest in contributing! We work primarily on Github. Please

1. At the time of this writing, Python 3.10, 3.11, and 3.12 are the officially supported versions.
2. This project implements the linting and formatting conventions of [`ruff`](https://docs.astral.sh/ruff/) on all incoming Pull Requests. To ensure a PR is properly linted and formatted prior to creating a Pull Request, [install `pre-commit`](https://pre-commit.com/#installation) in your development environment and then [set up the configuration of pre-commit hooks](https://pre-commit.com/#3-install-the-git-hook-scripts).

## Local development and tests

1. Install the package in editable mode:

```bash
pip install -e ".[dev]"
```

2. Download required example datasets before running tests:

```bash
python -c "import libpysal; libpysal.examples.fetch_all()"
```

3. Run the test suite:

```bash
pytest spopt/tests/
```
Comment on lines +15 to +29

Copilot AI Apr 11, 2026

Copy link

Choose a reason for hiding this comment

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

These fenced code blocks are indented with hard tab characters. GitHub-flavored Markdown can render tabs inconsistently inside ordered lists, and this also introduces literal tabs into the file. Prefer indenting the fenced blocks with spaces (typically 4 spaces under the list item) and update the other two blocks similarly for consistent rendering.

Suggested change
```bash
pip install -e ".[dev]"
```
2. Download required example datasets before running tests:
```bash
python -c "import libpysal; libpysal.examples.fetch_all()"
```
3. Run the test suite:
```bash
pytest spopt/tests/
```
```bash
pip install -e ".[dev]"
```
2. Download required example datasets before running tests:
```bash
python -c "import libpysal; libpysal.examples.fetch_all()"
```
3. Run the test suite:
```bash
pytest spopt/tests/
```

Copilot uses AI. Check for mistakes.
Loading