Comment on a PR

Commenting on a pull request is a crucial part of using Neo.

Whether you're seeking clarification, requesting changes, or offering praise, Neo can assist with all types of comments.

Neo made the pull request

If Neo made the pull request, you just need to leave a comment. This can either be on an individual line of code, or at the top level on the whole PR.

⚠️ Careful! Due to limitations in most code repositories tools (e.g. Bitbucket, GitLab, ADO), Neo can’t tell when you comment on a specific commit. Be sure to comment on the “files” or “changes” part of the whole pull request. (GitHub is an exception to this)

When Neo starts working on it, it will react to your comment with a thumbs up (or similar).

⚠️ Bitbucket doesn’t have an API for reactions to comments, so instead Neo will leave a reply to your comment.

If you leave lots of comments, Neo will handle them one at a time

Someone took over Neo’s pull request

Sometimes Neo makes a good PR, but you take it over and push commits to it to finish it off.

In that situation, Neo will stop responding to comments on that PR. It will let you know when it has decided to do this!

To bring Neo back to the PR, you need to @ mention it in a comment. Make sure you properly select Neo’s user account in the auto-complete, rather than just typing Neo’s name.

You made the pull request

Sometimes Neo isn't the pull request owner. For instance, when Neo has reviewed someone’s pull request or you want help with your own PR.

To summon Neo in these scenarios, mention it using @neo in your comment.

What Neo will do

Usually, in response to your comment, Neo will update the PR with a new commit.

Neo will read your comment in context of the thread it is in, the pull request summary and the code changes in the PR or that your comment is referencing.

💡 It’s fun to get Neo to do your work responding to a colleague’s review of your PR. Just write something like “@neo do it!” in response to the review comment!

You can also ask Neo:

Don’t forget to sometimes praise or thank Neo!