Contributing

Development environment

1. Clone and install:

   git clone https://github.com/sethfischer/cq-electronics.git
   cd cq-electronics
   poetry env use python3.12
   poetry install
   eval $(poetry env activate)
   

2. Install Git hooks:

   make install-git-hooks
   

3. Install CQ-editor:

   poetry install --with cq-editor
   

4. Open examples from the examples directory with CQ-editor:

   cq-editor examples/raspberry_pi_3b.py
   

Documentation

Build the documentation:

make -C docs/ clean html

Publish release

git checkout main
cz bump --no-verify
git push origin main && git push --tags
make poetry-build
poetry publish