Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.18 KB

DEVELOPMENT.md

File metadata and controls

39 lines (27 loc) · 1.18 KB
Raw

Contributing

Please make sure that your PR works with Blender 2.80:

  • That requires you to use python 3.7 and
  • Compatible Blender API (do a version check)
  • Remember to update CHANGELOG: https://keepachangelog.com/en/1.0.0/
  • Upcoming releases (roadmap) are planned in milestones
  • Generally don't commit commented out code unless there is a really good reason
  • Prefer comments to be full sentences

Structure

  • Blender entrypoint is in pythonFiles/launch.py
  • VS Code entrypoint is src/extension.ts. Refer to VS code docs, there is nothing non standard here.

Python guideline

Use Black formatter with black --line-length 120

Python tests

There is no clear guideline or commitment to testing.

Some tests are prototyped in pythonFiles/tests/blender_vscode/test_load_addons.py. They should be run outside of Blender what makes them easy to execute, but prone to breaking: there is a lot of patching for small number of test.

Run tests:

pip install pytest
cd pythonFile
$env:PYTHONPATH="./include" # powershell
pytest -s .\tests

Typescript guideline

Nothing more than tslint.json.