Skip to content

Comments

Comments on an issue are GitHub comments. They appear in GitHub, in Pealboard, and — for the ones you mark — in the portal.

Type into Add a comment and select Comment. It is written to GitHub first and appears once GitHub has it.

Comments support GitHub’s Markdown, including mentions. A mention notifies the person through GitHub in the usual way; Pealboard does not intercept it.

If the issue is a request from a portal, the comment box carries a Reply to portal toggle.

  • Toggle off: the comment is internal. Customers never see it, under any circumstance.
  • Toggle on: the button reads Reply to portal and the comment is a public comment. It appears in the portal, attributed to the workspace rather than to your GitHub login, and the requester is emailed.

A public comment carries a Public badge in the workspace, in addition to being placed differently, so the distinction is never carried by color alone.

A portal customer sees:

  1. Comments they and their colleagues wrote in the portal.
  2. Comments a member wrote with Reply to portal.
  3. Every other comment on the issue — only if a workspace admin turned on Show every GitHub comment to customers for that portal. This is off by default.

Nothing an engineer types into GitHub reaches a customer unless the workspace chose that, either per comment or once for the whole portal.

Edit or delete your own comments. Both are writes to GitHub and both appear there. A deleted public comment disappears from the portal too; the customer is not told it was deleted.