github-copilot-use-cases copilot-instructions.md

GitHub Copilot Instructions and Use Cases

Overview

This document provides comprehensive guidelines and use cases for effectively using GitHub Copilot in software development projects.

General Copilot Best Practices

Code Generation

• Write clear, descriptive comments before generating code
• Use meaningful function and variable names as context
• Break complex tasks into smaller, focused functions
• Review and test all generated code before committing

Prompt Engineering

• Be specific about requirements and constraints
• Include relevant context in comments
• Use examples when requesting specific patterns
• Iterate on prompts to improve results

Common Use Cases

1. Function Implementation

// Generate a function that validates email addresses using regex
// Should return true for valid emails, false otherwise

2. Documentation Generation

# Generate comprehensive docstring for this function
def process_data(data, filters, options):
    # Implementation here

3. Test Case Creation

// Generate unit tests for the UserService class
// Include positive and negative test cases
// Use Jest testing framework

4. Code Refactoring

// Refactor this method to use dependency injection
// Apply SOLID principles
// Improve error handling

5. API Integration

# Create a REST API client for GitHub API
# Include authentication and error handling
# Support GET, POST, PUT, DELETE operations

Language-Specific Guidelines

JavaScript/TypeScript

• Request TypeScript interfaces for data structures
• Ask for proper async/await patterns
• Include error handling with try/catch blocks
• Request JSDoc comments for functions

Python

• Ask for type hints in function signatures
• Request docstrings following Google or NumPy style
• Include proper exception handling
• Request logging where appropriate

Java

• Request proper access modifiers
• Ask for JavaDoc comments
• Include appropriate design patterns
• Request proper exception handling