Skip to content

Latest commit

 

History

History
56 lines (47 loc) · 2.43 KB

add-a-new-workbench-addon-to-this-repo.md

File metadata and controls

56 lines (47 loc) · 2.43 KB
name about title labels assignees
Add a new Workbench/Addon to this Repo
I want to contribute a new Workbench/Addon
[New Addon/Workbench]
New WB/Addon 📦

Dependencies

  • This Addon/workbench runs on:
    • Most up to date stable release
    • Most up to date development release
    • Python 3 compatible
    • Qt5 compatible
    • Qt5 and Qt6 compatible (uses "import PySide" rather than "import PySide2")
  • Is this backward compatible with any previous version of FC? If so, please mention in the README.md
  • Does this use 3rd party dependencies?
    • numpy
    • scipy
    • Please specify if there are any other dependencies below and in the README.md and package.xml files

README.md

  • Is Markdown friendly
  • Has a Prerequisite or Dependencies section
  • Links to a LICENCE file (Note: FreeCAD uses LGPL2.1, most people choose that or GPL3)
  • Has a Screenshot and/or a section for screenshots
  • Links to a FreeCAD Forum discussion thread

Misc.

Housekeeping

  • Fixed typos in the code using codespell. We recommend running: codespell -q 3
  • We recommend linting python code with PEP8. See [coding conventions][Code-conventions]

Github Related

  • Does your repository use Release tags ?
  • Repository has topics which include FreeCAD Workbench Addon

Note: if your addon/workbench code doesn't reside on Github, please state the address where it is mentioned