Skip to content

Advanced

Report a Bug

Whenever encountering a bug follow these steps:

  • Check if the bug is already reported on github
  • Try to reliably reproduce the bug and simplify the steps to reproduce
  • Collect the addon logs
  • In case of a crash also collect blender's crash report
  • Post the bug on github

Console Output

Blender doesn't print system output in it's info editor but only in the system terminal. Follow the guide below to access blender's system console.

To see the system output blender has to be started from the terminal

  • Open a console by pressing Ctrl+Alt+T
  • Enter "blender" or the path to a specific blender version
  • In blender click Window->Toggle System Console

Access Logs

Logs are helpful for debugging. Note that there are logs from the addon as well as from blender itself.

Addon Logs

The addon logs information to the system console and to the system's temporary folder. The filepath to this folder will be printed to the console whenever the addon gets registered.

CAD_Sketcher:{INFO}: Logging into: C:\Users\USERNAME\AppData\Local\Temp\CAD_Sketcher.log

Blender Crash Log

When blender crashes it writes a crash report file, see: crash report.

Contribute

Help is always welcome. There are multiple ways to support the project.

Testing

Just grab the latest version, play around, provide feedback and redo!

Documentation

Documentation is generated from the source repository with MkDocs. In order to contribute either post a pull request with your changes on github or ask on discord for commit access.

Development

If you'd like to help with development simply submit pull requests or reach out on discord, or github.

Take a look at the existing code documentation, this isn't complete yet, if you are missing some specific information feel free to ask in the discord's contribute channel.

Have a look at the open issues on github. Some of them are alos marked with the "good first issue" tag, see here. Also take a look at the raodmap to see where the priority currently lies.