File tree Expand file tree Collapse file tree 1 file changed +20
-0
lines changed Expand file tree Collapse file tree 1 file changed +20
-0
lines changed Original file line number Diff line number Diff line change 1+ # ChipFlow Library Development Guidelines
2+
3+ ## Build & Test Commands
4+ - Install dependencies: ` pdm install `
5+ - Run all tests: ` pdm run test `
6+ - Run a single test: ` pdm run python -m pytest tests/test_file.py::test_function -v `
7+ - Run tests with coverage: ` pdm run test-cov `
8+ - Run linting: ` pdm run lint `
9+ - Build documentation: ` pdm run docs `
10+ - Test documentation: ` pdm run test-docs `
11+
12+ ## Code Style Guidelines
13+ - License header: Include ` # SPDX-License-Identifier: BSD-2-Clause ` at the top of each file
14+ - Use type hints where appropriate (Python 3.10+ supported)
15+ - Imports: Group standard library, third-party, and project imports with a blank line between groups
16+ - Formatting: Project uses ruff (` F403 ` , ` F405 ` are ignored)
17+ - Naming: Use snake_case for functions/variables and PascalCase for classes
18+ - Error handling: Custom errors inherit from ` ChipFlowError `
19+ - Documentation: Follow sphinx docstring format for public APIs
20+ - Testing: Use pytest fixtures and assertions
You can’t perform that action at this time.
0 commit comments