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 b767b78a69 pack(): introduced a new helper for packing parts into a 2D footprint. 
Also added documentation for the new facility as well as a nascent
CONTRIBUTING.md to collect pointers to the tools used by developers of
this project.
2023-11-09 15:06:49 -08:00

747 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 pylint pytest mypy sphinx
  • Install docs dependencies: pip install -r docs/requirements.txt (might need to comment out the build123d line in that file)
  • Install build123d in editable mode from current dir: pip install -e .
  • Run tests with: python -m pytest
  • 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>