Course navigation

Post comments on GitHub

CodeCrab Docs · Post comments on GitHub

On GitHub pull requests you can publish a finding's suggested comment, or your own note, on a diff line without leaving CodeCrab. Nothing is posted until you click Post on GitHub.

What CodeCrab posts, and when

  • Available on GitHub PRs in Assigned to Me and Team PRs.
  • Drafts stay on your machine until you click Post on GitHub. CodeCrab never posts on its own.
  • It never approves, merges or pushes, and never edits your local clone.
  • On GitLab, use the link to the merge request and paste the comment yourself.

Post a finding's comment

ActionWhat it does
Copy PR CommentCopies the ready-to-paste comment.
Post on GitHubPosts the suggested comment as a review comment on that file and line. Edit it first in the markdown editor (Write / Preview, with a small formatting toolbar).
Open on GitHubOpens the PR's Files tab at that line, if you prefer to paste yourself.

Write your own comments on the diff

  1. Hover a diff line (added, context or deleted) and click the blue +.
  2. Write in the markdown editor (Write / Preview). Drafts are saved locally and stay under that line if you switch tabs or restart the app.
  3. Click Discard to remove the draft, or Post on GitHub to publish it as a review comment on that line.
  4. Cards are collapsible, like findings. After posting, the + no longer appears on that line; open the card to re-read it or open it on GitHub.

PR header links

Open in GitHub opens the PR. Open {KEY} opens the linked Jira ticket, and only appears when the PR links one.

Connect Jira →

Back to Review a PR →