Code review & refactoring with GitHub Copilot: A beginner's guide

Key Concepts

• Code Review: Examining code for bugs, quality, and consistency.
• Refactoring: Restructuring code without changing its functionality to improve efficiency and readability.
• GitHub Copilot: An AI tool that assists in writing, reviewing, and refactoring code.
• Automated Suggestions: Copilot's ability to provide improvement and optimization suggestions.
• Consistency Checks: Copilot's feature to maintain coding standards.
• Refactoring Assistance: Copilot's actionable tips for simplifying and reorganizing code.
• Error Detection: Copilot's ability to identify potential bugs and inefficiencies.
• Comment Support: Copilot's feature to generate clear comments for better code understanding.
• Custom Hooks: Reusable functions that encapsulate logic for use in multiple components.
• Redundant Code: Unnecessary or repetitive code that can be removed or consolidated.
• Pull Request (PR): A request to merge code changes into a main branch.

Code Review and Refactoring: Definitions and Importance

Code review is presented as a "second pair of eyes" on code, crucial for catching bugs, improving code quality, and ensuring consistency. Refactoring is defined as restructuring existing code without altering its functionality, likened to "tidying up your workspace." Maintaining clean and efficient code is emphasized as vital for easier future development work.

GitHub Copilot's Role

GitHub Copilot is highlighted as a tool that assists not only in writing code but also in streamlining the review and refactoring processes. It helps in making the process smoother and more efficient.

Real-World Examples of Copilot in Action

• Function Refactoring: Copilot can analyze a long, complex function and suggest breaking it down into smaller, more manageable pieces or optimizing its logic for better performance.
• Naming Convention Consistency: Copilot can automatically suggest correct variable names to ensure consistency across a project, adhering to team standards.
• Dashboard Component Improvement: The presenter demonstrates using Copilot Chat to ask, "How can I improve this code?" for a Dashboard component. Copilot provides suggestions that can be applied directly in the editor.
• Custom Hook Creation: The presenter asks Copilot, "How can I extract the data fetching logic into a custom hook?" Copilot generates refactored code to move the data fetching logic from the Dashboard component into a reusable custom hook.
• Redundant Code Identification: The presenter asks, "Are there any redundant code in this file?" Copilot identifies and corrects redundancies in the generated code block.

Step-by-Step Process: Using Copilot Chat for Refactoring

1. Open Copilot Chat.
2. Ask a question like, "How can I improve this code?" or "How can I extract the data fetching logic into a custom hook?".
3. Review Copilot's suggestions.
4. Click "Apply in Editor" to implement the changes.
5. Ask Copilot to explain each suggestion step-by-step for better understanding.

GitHub Copilot Code Review on GitHub.com

• Requesting a Review: On a pull request, a "Copilot" option appears under "Reviewer." Clicking "Request" initiates a Copilot review.
• Review Type: Copilot always leaves a "Comment" review, not an "Approve" or "Request changes" review. This means Copilot's reviews don't count toward required approvals or block merging.
• Accepting Suggestions: Suggestions can be accepted individually via the "Commit suggestion" dropdown or in batches using the "Add to batch" button.
• Workflow: Copilot can provide an initial review before involving the team for a final review.

Key Components of Using Copilot for Code Review and Refactoring

1. Automated Suggestions: Copilot suggests improvements and optimizations.
2. Consistency Checks: Copilot helps maintain coding standards.
3. Refactoring Assistance: Copilot provides actionable refactoring tips.
4. Error Detection: Copilot spots potential bugs or inefficiencies.
5. Comment Support: Copilot helps generate clear comments.

Limitations and Cautions

• Copilot relies on the context provided. Unclear or poorly documented code may lead to less effective suggestions.
• Copilot is not a substitute for thorough human review. Always double-check suggested changes to ensure they align with project goals, standards, and organizational policies.
• Copilot, as an LLM, has limitations and should be used with caution.

Synthesis/Conclusion

GitHub Copilot is presented as a valuable tool for code review and refactoring, helping to maintain clean, efficient, and consistent code. It saves time, reduces errors, and allows developers to focus on building features. While powerful, it's essential to remember that Copilot is an assistant and not a replacement for human oversight and critical thinking. The presenter encourages viewers to sign up for GitHub Copilot and explore its capabilities.