Skip to content

Conversation

@tphung3
Copy link
Contributor

@tphung3 tphung3 commented Sep 17, 2025

Proposed Changes

This PR proposes adding Copilot as an automatic code reviewer to all PRs in CCTools. An example of how Copilot works is in this PR #4236 (also this PR). This is expected to help improve the productivity, catch errors, and maintain the health of CCtools' codebase via Copilot.

Per enabling Copilot to review code, there's 3 structural ways of doing it, per PR, per repository, or per organization (see https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/configure-automatic-review). The example PR above uses the per PR approach. Considerations are needed however to whether use Copilot as a code reviewer, and if so on which level should we enable Copilot. Costwise it's pretty reasonable ($10/month for 1 person), and it's currently free for verified students and teachers (see https://docs.github.com/en/copilot/how-tos/manage-your-account/get-free-access-to-copilot-pro) for 2 years (from what I observed).

Merge Checklist

The following items must be completed before PRs can be merged.
Check these off to verify you have completed all steps.

  • make test Run local tests prior to pushing.
  • make format Format source code to comply with lint policies. Note that some lint errors can only be resolved manually (e.g., Python)
  • make lint Run lint on source code prior to pushing.
  • Manual Update: Update the manual to reflect user-visible changes.
  • Type Labels: Select a github label for the type: bugfix, enhancement, etc.
  • Product Labels: Select a github label for the product: TaskVine, Makeflow, etc.
  • PR RTM: Mark your PR as ready to merge.

Copilot AI review requested due to automatic review settings September 17, 2025 21:54
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds an optional instruction to the pull request template to request Copilot code reviews for CCtools PRs. The change aims to improve code quality and productivity by encouraging the use of GitHub Copilot's automated code review capabilities.

Key changes:

  • Adds a new optional checklist item for requesting Copilot code reviews

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

- [ ] Manual Update: Update the manual to reflect user-visible changes.
- [ ] Type Labels: Select a github label for the type: bugfix, enhancement, etc.
- [ ] Product Labels: Select a github label for the product: TaskVine, Makeflow, etc.
- [ ] [Optional] Request Copilot's review: Request a code review from Copilot (or ask @tphung to request one for you).
Copy link

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instruction lacks clarity about how to request Copilot's review. Consider adding a link to documentation or brief instructions on how to add Copilot as a reviewer.

Suggested change
- [ ] [Optional] Request Copilot's review: Request a code review from Copilot (or ask @tphung to request one for you).
- [ ] [Optional] Request Copilot's review: To request a review from Copilot, click "Reviewers" in your PR and select "github-copilot[bot]". For more details, see [GitHub Copilot Code Review documentation](https://docs.github.com/en/copilot/github-copilot-in-github/github-copilot-code-review). If you need help, ask @tphung to request one for you.

Copilot uses AI. Check for mistakes.
@tphung3 tphung3 requested a review from dthain September 17, 2025 21:55
@dthain
Copy link
Member

dthain commented Sep 18, 2025

I would like to see more examples of the review quality before adding this to our standard workflow. In the example you showed, it adds a lot of noise (obvious summary of files) but also points out one meaningful error.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants