Notes on GitHub Copilot Presentation

Introduction

• Speaker: Christopher Harrison, Senior Developer Advocate at GitHub
• Topic: GitHub Copilot and how to maximize its use
• Reminder: AI tools are just that – tools, similar to IDEs.

Overview of GitHub Copilot

• Suite of tools primarily focused on code completion.
• Embedded experience within IDEs and editors:
  • Generates suggestions based on comments and code.

How GitHub Copilot Works

• Context sent to GitHub Copilot includes:
  • Entire content of the file (not just the cursor position).
  • Open tabs in the IDE (focuses on related tabs).
• Uses OpenAI LLM to generate suggestions based on context.
• Allows for accepting, rejecting, or modifying suggestions.

Understanding Context

• Context includes:
  • Full content of the current file.
  • Relevant tabs open in the IDE.
• Important to manage which files are open to maintain relevant context.

Prompt Crafting

• Definition: The way to phrase comments, code, and prompts to maximize tool effectiveness.
• Key components:
  • Context: What is being built and how.
  • Intent: What the developer aims to achieve.
  • Clarity: Avoid complex jargon; use simple language.
  • Specificity: Provide detailed instructions (e.g., instead of "get ice cream," specify flavor and form).

Best Practices for Using GitHub Copilot

1. Describe the Goal:
   • Include a brief header comment at the top of the file describing what you are building.
2. Be Flexible:
   • AI tools are probabilistic; results may vary even with the same input.
   • Adjust prompts if the suggestions aren't what you expect.
3. Provide Examples:
   • Giving examples can clarify expectations for Copilot.

Example Demo

• Building a conference website using Python Django.
• Suggested code generation based on comments.
• Importance of specificity in comments (e.g., specifying fields in a model).

Naming Conventions

• Use clear and descriptive variable names to help Copilot provide better suggestions.
• Avoid abbreviations that can confuse both developers and AI tools.

Following Best Practices

• Make sure to use good naming conventions and clear code.
• Show examples of desired output in comments to influence suggestions.

Conclusion

• Emphasized the importance of being clear, flexible, and specific while using GitHub Copilot.
• Encourage developers to adapt their approach based on feedback from Copilot suggestions.
• AI tools can improve coding efficiency when used effectively.