Skip to content

Community-driven GitHub Copilot settings and coding guidelines. Share, improve, and evolve best practices for AI-assisted coding in Visual Studio Code. Contribute by suggesting new rules or refining existing ones via pull requests.

License

Notifications You must be signed in to change notification settings

LightZirconite/copilot-rules

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Copilot Rules

Instructions for GitHub Copilot to improve code quality and enforce best practices.

Features

  • Code in English - All code output in English (variables, functions, comments)
  • Response in your language - Copilot responds in the language you use
  • Production-ready code - No placeholders, proper error handling
  • Modern patterns - TypeScript strict mode, React hooks, async/await
  • Anti-hallucination - Verifies libraries/APIs before using them
  • Action-oriented - Executes immediately, no permission asking

Quick Install

Windows (PowerShell)

irm https://raw.githubusercontent.com/LightZirconite/copilot-rules/main/scripts/install-copilot-instructions.bat -OutFile i.bat; .\i.bat; rm i.bat

macOS / Linux

curl -fsSL https://raw.githubusercontent.com/LightZirconite/copilot-rules/main/scripts/install-copilot-instructions.sh | bash

Manual Installation

  1. Copy instructions/global.instructions.md to your VS Code prompts folder:

    • Windows: %APPDATA%\Code\User\prompts\
    • macOS: ~/Library/Application Support/Code/User/prompts/
    • Linux: ~/.config/Code/User/prompts/
  2. Enable instruction files in VS Code settings:

    {
      "github.copilot.chat.codeGeneration.useInstructionFiles": true
    }
  3. Reload VS Code (Ctrl+Shift+PDeveloper: Reload Window)

What It Does

The instructions teach Copilot to:

  1. Write code in English - Consistent, professional codebases
  2. Execute tasks immediately - No "Should I proceed?" questions
  3. Handle edge cases - Empty arrays, API errors, undefined values
  4. Follow security practices - No hardcoded secrets, SQL injection prevention
  5. Provide complete code - No // ...existing code... fragments

Contributing

See CONTRIBUTING.md.

License

MIT - LICENSE

About

Community-driven GitHub Copilot settings and coding guidelines. Share, improve, and evolve best practices for AI-assisted coding in Visual Studio Code. Contribute by suggesting new rules or refining existing ones via pull requests.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published