mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-06 02:30:55 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
build123d/CONTRIBUTING.md
Ami Fischman bda0a6a719 Run tests in parallel by default, and update CONTRIBUTING.md to recommend this flow. 
test_mesher.py was reusing the same filename across tests which meant
that when running in parallel tests would stomp on each
other. Robustified by having each test use a distinct file name.
2025-02-22 11:37:58 -08:00

830 B
Raw Blame History

When writing code for inclusion in build123d please add docs and tests, ensure they build and pass, and ensure that pylint and mypy are happy with your code.

  • Install pip following their documentation.
  • Install development dependencies: pip install -e .[development]
  • Install docs dependencies: pip install -e .[docs]
  • Install build123d in editable mode from current dir: pip install -e .
  • Run tests with: python -m pytest -n auto
  • Build docs with: cd docs && make html
  • Check added files' style with: pylint <path/to/file.py>
  • Check added files' type annotations with: mypy <path/to/file.py>
  • Run black formatter against files' changed: black --config pyproject.toml <path/to/file.py> (where the pyproject.toml is from this project's repository)