Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.99 KB

Welcome

Thank you for visiting the blenderpy repository, and viewing the contribution guidelines.

Getting Started

Much of the Blender as a Python module build orchestration is provided by VS Code tasks. Some extensions are required to run some of the tasks. Please see the prerequisites.

Prerequisites

  1. Visual Studio Code
    1. VS Code Python Extension
    2. VS Code Tasks Shell Input
  2. Docker
  3. Windows Subsystem for Linux - (If on Windows) For faster Docker builds, otherwise Docker produces a warning
  4. Blender build requirements - See your operating system's requirements here

To see how to build, head over to the wiki.

Submit a bug report

If you find something that may be wrong with the code, please feel free to submit a bug report. Try and follow the guidelines outlined here. I will get back with you.

Submit a feature request

If you want some additional feature added to the repo, please try to follow the guidelines here, similarly to the bug report, I am open to discussions, so don't hesitate to ask! Additionally, if you want to be a little more informal and discuss it prior, you can always join me in the Discord

Create a Pull Request

Please when implimenting the pull request be sure to update the setup.py with any install_requires fields that may be necessary per your change. Describe in detail what the improvement is and we can talk about it.