docs: Update copilot instructions to include development environment setup and quality checks
This commit is contained in:
parent
50ce5abb6f
commit
79afa91490
1 changed files with 9 additions and 3 deletions
12
.github/copilot-instructions.md
vendored
12
.github/copilot-instructions.md
vendored
|
|
@ -64,17 +64,23 @@ def validate_path(path: Path, allowed_roots: List[Path]) -> bool:
|
||||||
6. **Run quality checks**: `tox -e lint,type`
|
6. **Run quality checks**: `tox -e lint,type`
|
||||||
7. **Update docs**: Add docstrings and update README if needed
|
7. **Update docs**: Add docstrings and update README if needed
|
||||||
|
|
||||||
|
## Development Environment
|
||||||
|
|
||||||
|
**Virtual Environment**: `.venv` (already created)
|
||||||
|
- Activate: `.venv\Scripts\activate` (Windows) or `source .venv/bin/activate` (macOS/Linux)
|
||||||
|
- All Python commands automatically use this environment through VS Code integration
|
||||||
|
|
||||||
## Common Commands
|
## Common Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Setup
|
# Setup (one-time)
|
||||||
pip install -r requirements-dev.txt
|
pip install -r requirements-dev.txt
|
||||||
|
|
||||||
# Testing
|
# Testing (uses .venv automatically)
|
||||||
pytest tests -v
|
pytest tests -v
|
||||||
pytest tests --cov=src/webdrop_bridge --cov-report=html
|
pytest tests --cov=src/webdrop_bridge --cov-report=html
|
||||||
|
|
||||||
# Quality
|
# Quality checks
|
||||||
tox -e lint # Ruff + Black checks
|
tox -e lint # Ruff + Black checks
|
||||||
tox -e type # mypy type checking
|
tox -e type # mypy type checking
|
||||||
tox -e format # Auto-format code
|
tox -e format # Auto-format code
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue