Studio: Copy report on Status, with the user name and folders hidden

Abierto
  • ¿Algo no está bien?
#116 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@combwizard ya está trabajando en esto.

Desde el 3/11/2026.

  • #129 de @combwizard — abierto

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
desktop, documentation

Línea de trabajo

Start with the Status screen code in studio.py (or the new report.py) next to the existing Copy log action, and the log file locations it reads. Add the report builder and its redaction, which needs tests for a user name inside a path, inside a quoted command line, and as an ordinary word. The bug form's Logs field (bug_report.yml), files.md, troubleshooting.md and studio.md also need updating. Done when the report text is built and redacted as specified, the tests pass, and the docs point to Copy report.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

enhancement studio

Making a bug report today means finding two to six logs in %LOCALAPPDATA%\ZOrbit (the bug form lists which ones for each ZBrush version), taking the end of each, and blacking out your Windows user name and folder paths by hand. The versions get typed into the form by hand too. Reports come in incomplete at this step, and it's where a name slips through.

Add Copy report to the Status screen, next to Copy log. It copies one block of text with:

  • the ZOrbit version, how it was installed (Setup, portable, source), and the Windows version and build
  • the ZBrush installs Studio knows, which one is running, and whether it runs as administrator
  • the bridge mode and key, the four Status cards as they stand, and the profile in use
  • the problems in the menus file, if there are any
  • the end of each log that fits the setup: radiald.log, then bridge.log for 2026 and newer or the three zscript_*.log for 2022 to 2025, plus popout.log, studio.log, and app_stderr.log when it's recent. Each is trimmed to the current session where the log marks one, with a line cap.

Before it copies, %LOCALAPPDATA% and the home folder are swapped back to their variable names (longest path first), and the user name becomes <user>. The name is only replaced inside a path or a command line, so a user called brush doesn't eat the log. Brush names and menu ids stay, because they're what makes a log useful. The toast says the name and folders were hidden.

A Report a bug link next to it opens the bug form with the version fields filled in from the URL (issue forms take ?template=bug_report.yml&zorbit=...&zbrush=...). The report itself is too long for a URL, so it goes in from the clipboard.

  • Build the text in studio.py (or a small report.py), with tests for the redaction: the name in a path, in a quoted command line, and a name that's also an ordinary word
  • Copy report and Report a bug on Status
  • Point the bug form's Logs field, files.md and troubleshooting.md at Copy report instead of the list of files. While there, fix troubleshooting.md: it says --check is for a source checkout, but the exe has it too
  • studio.md, CHANGELOG
Lenguaje dominante
Python
Estrellas
2
Forks
1
Merge medio
1 h 1 min
PR fusionados (30 d)
10

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de combwizard/ZOrbit

Todos los issues de combwizard/ZOrbit

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.