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.

How to ask Neo

Leave a comment on the PR which @ mentions Neo. e.g. “@neo factor this out into a separate function”.

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

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:

  • Which file and line of code it is on

  • Any thread it is in

  • Pull request title and summary

  • Code changes in the pull request

  • Any ticket associated with the pull request

💡 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:

  • A question about its code or the PR, and it will answer.

  • To revert the last commit.

  • To fix a broken build for you, see Fixing CI/CD issues.

Don’t forget to sometimes praise or thank Neo!