Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

51 lines (42 loc) · 3.72 KB
Raw

Welcome

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

By your visit here, the assumption is that you would like to contribute to the code base, or become a maintainer of a certain portion of the code. If not, and you were just looking to publish an issue, then you don't have to read all of this, and can simply go to the issues tracking page.

Your contributions are most welcome! This is a somewhat informal repository, in that there aren't many maintainers (just me as of writing 1st of May, 2019!) and I am always willing to help or provide some insight if you are doing some development with this.

Quick Links

Get started

blenderpy is somewhat of a complicated solution. This repository actually doesn't do much on its own; it mostly exists so that we can control how the bpy required files get distributed (more here). For the building of the bpy files, the bpy-build repository is used (a requirement of this repository) and for the final placement of all the files, bpy-ensure is used (places the /Scripts file in the correct location, which has been an issue before).

Therefore in order to contribute to the project as a whole, you are going to want to check out three repos. Follow the steps below:

  1. Clone the repository git clone https://github.com/TylerGubala/blenderpy into the directory of your choice
  2. Clone the repository git clone https://github.com/TylerGubala/bpy-build into the directory of your choice
  3. Clone the repository git clone https://github.com/TylerGubala/bpy-ensure into the directory of your choice
  4. cd blenderpy
  5. mkdir venv
  6. cd venv
  7. py -3.6-32 -m venv 3.6-32 optional: replace 3.6-32 with your preferred python version
  8. cd ..
  9. venv/3.6-32/Scripts/activate
  10. (3.6-32)py -m pip install -r requirements.txt
  11. cd bpy-build
  12. mkdir venv
  13. cd venv
  14. py -3.6-32 -m venv 3.6-32 optional: replace 3.6-32 with your preferred python version
  15. cd ..
  16. venv/3.6-32/Scripts/activate
  17. (3.6-32)py -m pip install -r requirements.txt
  18. cd bpy-ensure
  19. mkdir venv
  20. cd venv
  21. py -3.6-32 -m venv 3.6-32 optional: replace 3.6-32 with your preferred python version
  22. cd ..
  23. venv/3.6-32/Scripts/activate
  24. (3.6-32)py -m pip install -r requirements.txt
  25. optional: To watch the build process, run bpy-build/setup.py in your preferred coding environment with a debugger attached

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.