CCtools: Add instruction to add Copilot as a code reviewer to all PRs to CCtools #4237
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 testRun local tests prior to pushing.make formatFormat source code to comply with lint policies. Note that some lint errors can only be resolved manually (e.g., Python)make lintRun lint on source code prior to pushing.