Docs

Sending Feedback

Reporting bugs and feedback from inside the editor.

PipeIt can file bug reports and feedback from inside the editor. Reports are anonymized before anything leaves your machine, and you review the exact text that will be sent.

Opening the dialog

There are two entry points:

  • Help → Report a PipeIt Issue…: a general report, from anywhere.
  • With a Pipe Network selected, the Report a Bug / Send Feedback… button in the details panel: the same dialog, with that network’s graph data attached so we can reproduce graph-specific problems.

Sending a report

  1. Pick the report type: Bug report or Feedback / feature request.
  2. Write a short title and describe the issue: what you did, what you expected, and what happened. Steps to reproduce help the most.
  3. Choose what to attach. Each toggle adds a section to the report:
    • System info: PipeIt version, engine version, OS, and GPU.
    • Recent operations: the last PipeIt actions you performed.
    • Log (PipeIt lines + errors): the PipeIt-related lines from the editor log.
    • Graph dump: the selected network’s structure (only available when the dialog was opened from a Pipe Network’s details panel).
  4. Click Generate Preview. The full report appears in an editable preview box. Read it, edit it if you want; exactly the text you see is what gets sent.
  5. Click Submit to GitHub.

After a successful submit, the created issue opens in your browser. If a screenshot would help, add it there; images are attached on the issue page, not through the dialog.

Signing in the first time

Reports are filed as your GitHub user on the public PipeIt feedback repository, so submitting requires a one-time GitHub sign-in:

  1. Click Sign in with GitHub in the dialog.
  2. A browser page opens at github.com/login/device, and the dialog shows a short code (with a Copy Code button).
  3. Enter the code on the GitHub page and approve.

The dialog switches to Signed in as <your login> and remembers the sign-in for future reports. Sign out in the dialog forgets it. The authorization can only open issues on the public feedback repository; it grants no access to your own repositories.

What the anonymization covers

Before the preview is generated, names that could identify you or your project are replaced with anonymous tokens (for example Asset_3F2A91C4):

  • your project’s name and folder, your OS user name, and your machine name;
  • actor labels in the open level;
  • your own asset names and /Game/... content paths.

PipeIt’s own content and engine content are not obscured; those names are the same for everyone and are usually what a report is about. Tokens are randomized per report, so two reports cannot be correlated. The preview is the final gate: nothing is sent that you have not seen.