Structure

Layout

Overview of all files in the template.

GitHub

│
├─ .github
│  ├─ CONTRIBUTING.md
│  └─ FUNDING.md

• .github/CONTRIBUTING.md
  Describes what contributors should look out for, GitHub
  links this file in the sidebar & the repository overview tabs.

• .github/FUNDING.md
  Displays a widget in the sidebar where people can donate.

Editor

│
├─ .vscode
│  └─ extensions.json

• .vscode/extensions
  Recommends users extensions to use
  when opening the project in their editor.

Documentation

│
├─ Documentation
│  ├─ Usage
│  │  └─ Howto-X.md
│  └─ README.md

• Documentation/README.md
  Entrypoint for the documentation linked in the manifest.

• Documentation/Usage/Howto-X.md
  Some usage information.

Resources

│
├─ Resources
│  ├─ Documents
│  │  └─ Overview.md
│  ├─ Icons
│  │  └─ Logo.svg
│  └─ Media
│     └─ Header.webp

• Resources/Documents/Overview.md
  Page shown in the addon manager overview of the addon.

  This is a simplified page compare to the repository README as it's meant
  only for users and because QT doesn't handle all Markdown features well.

• Resources/Icons/Logo.svg
  The icons used as the addons logo, declared in the manifest.

• Resources/Media/Header.webp
  Header image used on the README and the Overview page.

Logic

│
├─ freecad
│  └─ Minimal
│     ├─ Qt
│     │  ├─ Core.py
│     │  ├─ Gui.py
│     │  └─ Widget.py
│     ├─ Resources
│     │  └─ Icons
│     │     └─ Logo.svg
│     ├─ __init__.py
│     └─ init_gui.py

General

│
├─ .editorconfig
├─ .gitignore
├─ CHANGELOG.md
├─ LICENSE-CODE
├─ LICENSE-ICON
├─ README.md
├─ package.xml
└─ pyproject.toml

• .editorconfig
  Basic formatting presets most editors support.
  ( Line Endings , Spacing Type , .. )

• .gitignore
  Ignore the Python cache directories & environments.

• CHANGELOG.md
  Additions, fixes, changes, .. for every version.

• LICENSE-CODE
  License for the source code of the addon.

• LICENSE-ICON
  License for the icons included in the addon.

• README.md
  Displayed as the front page of the repository.

• package.xml
  Manifest that declares the metadata of the addon.

• pyproject.toml
  Config to define the development dependencies.