community/

GitHub Copilot Instructions

public

Custom instructions file for GitHub Copilot. Place in .github/copilot-instructions.md to guide Copilot's suggestions.

·
github-copilot copilot starter
0 0 0

Install Configuration

Use the CLI to install this configuration to your local machine.

shai install community/github-copilot-instructions
shai uninstall community/github-copilot-instructions

Don't have the CLI? Install it with: gem install shai-cli

.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