Skip to content

armgit / SOMA

Public Imported from GitHub
0

Desktop app for designing parametric 3D models in CadQuery together with the coding agent of your choice

GitHub: Sicherheitshinweise und Vorlagen fuer Issues

Kai-Jungsthoefel09b36f108b7e
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..4a7a7c2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,68 @@
+name: Bug report
+description: Something in SOMA does not work as it should
+labels: [bug]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time. Security problems please not here, see [SECURITY.md](https://github.com/Kai-Jungsthoefel/SOMA/blob/main/SECURITY.md).
+ Before sharing a model, screenshot or log, check that it contains nothing private.
+ - type: textarea
+ id: what
+ attributes:
+ label: What happened?
+ description: What did you do, what did you expect, and what happened instead?
+ validations:
+ required: true
+ - type: textarea
+ id: steps
+ attributes:
+ label: Steps to reproduce
+ placeholder: |
+ 1. Create a new model
+ 2. Ask the agent to ...
+ 3. Click on ...
+ - type: dropdown
+ id: area
+ attributes:
+ label: Area
+ options:
+ - Installation or start
+ - Viewer, measuring, section, exploded view
+ - Building a model (soma build, errors)
+ - Agent terminal
+ - Saving, opening, versions
+ - Analysis (FEM, overhang, wall thickness)
+ - Animation or rendering
+ - Technical drawings or DXF
+ - Export
+ - Skills or AGENTS.md
+ - Parameters
+ - Something else
+ validations:
+ required: true
+ - type: textarea
+ id: system
+ attributes:
+ label: System info
+ description: In SOMA open Settings > About and click "Copy system info", then paste it here. It contains the versions of SOMA, Python, CadQuery, Electron and your system.
+ render: text
+ validations:
+ required: true
+ - type: input
+ id: agent
+ attributes:
+ label: Agent and model
+ description: Only if the agent is involved.
+ placeholder: e.g. Claude Code with Claude Opus 5.5
+ - type: textarea
+ id: logs
+ attributes:
+ label: Error messages or output
+ description: Build errors, terminal output or the text of an error dialog.
+ render: text
+ - type: textarea
+ id: files
+ attributes:
+ label: Screenshots or model
+ description: Drag images or a small `.soma` file here (rename it to `.zip` if GitHub does not accept it). Only if you are fine with it being public.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..280dfb6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+ - name: Security problem
+ url: https://github.com/Kai-Jungsthoefel/SOMA/security/advisories/new
+ about: Please report vulnerabilities privately, not as an issue.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..b914908
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,32 @@
+name: Feature request
+description: An idea for SOMA, the soma library or the skills
+labels: [enhancement]
+body:
+ - type: textarea
+ id: problem
+ attributes:
+ label: What do you want to do?
+ description: Describe the situation and what is missing or tedious today. A real example (the part you were designing) helps most.
+ validations:
+ required: true
+ - type: textarea
+ id: idea
+ attributes:
+ label: Your idea
+ description: How could SOMA help? Rough is fine.
+ - type: dropdown
+ id: area
+ attributes:
+ label: Area
+ options:
+ - App (viewer, panels, workflow)
+ - soma library or command line
+ - Skills or AGENTS.md (instructions for the agent)
+ - Analysis, animation or drawings
+ - Installation and packages
+ - Something else
+ - type: textarea
+ id: more
+ attributes:
+ label: Anything else
+ description: Sketches, screenshots, links to other tools that do it well.
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 0000000..0cb10d4
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,36 @@
+# Security
+
+## Reporting a vulnerability
+
+Please do not report security problems in public issues. Use GitHub's private reporting instead:
+[Report a vulnerability](https://github.com/Kai-Jungsthoefel/SOMA/security/advisories/new) (tab "Security" > "Report a vulnerability").
+
+Please include the SOMA version (Settings > About > "Copy system info"), your system, and the steps or the file that
+trigger the problem. SOMA is maintained by one person in their spare time. You can expect a first answer within about two
+weeks. Fixes go into a new release, and the advisory is published once the fix is out.
+
+## Supported versions
+
+Only the latest release gets fixes. SOMA is at 0.x, there are no maintenance branches.
+
+## What SOMA does by design
+
+SOMA runs code. A few things are intended behavior, not vulnerabilities:
+
+- **A model is Python code, and SOMA runs it.** `model.py`, `parts/`, animations, analyses and drawings run with your
+ user rights whenever SOMA builds them, and building starts on its own once you work with a model. Only open `.soma` or ZIP files from people you trust, just like you would
+ only run their scripts.
+- **The agent runs in a normal terminal.** SOMA starts the CLI agent you chose in the model folder. What it may do is
+ decided by the agent and its permission settings, not by SOMA.
+- **Packages a model asks for are installed from PyPI.** Before building, SOMA installs what a model's
+ `requirements.txt` lists into a separate environment for that model. This is part of running the model's code.
+- **The packages are not signed yet.** Download them only from the
+ [releases page](https://github.com/Kai-Jungsthoefel/SOMA/releases) of this repository.
+
+What we do want to hear about, for example:
+
+- Opening a model or ZIP file that writes or reads files outside its own folder without running its Python code
+ (for example through path traversal in the archive or the project files)
+- Model content (file names, part names, Markdown, skills, PDFs) that runs script in the app window
+- Ways for a model or an agent to reach the app's internals beyond the documented `soma` command line
+- Problems in how the installers or the release workflow are built