.github/copilot-instructions.md
GitHub Copilot Instructions
Project Overview
<!-- Describe your project briefly here -->
Code Style
- Follow the existing code patterns in this repository
- Use descriptive variable and function names
- Keep functions concise and focused on a single task
- Write self-documenting code; minimize comments
Preferred Patterns
<!-- List patterns you want Copilot to follow -->
- Use async/await over callbacks
- Prefer functional programming patterns where appropriate
- Use early returns to reduce nesting
Testing
- Write tests for new functions
- Follow the existing test patterns in the codebase
- Include edge cases in tests
Documentation
- Add JSDoc/docstrings for public APIs
- Keep README up to date with significant changes
Avoid
<!-- List anti-patterns to avoid -->
- Avoid deeply nested code
- Don't use deprecated APIs
- Avoid magic numbers; use named constants