Skip to content

Conversation

Copy link

Copilot AI commented Jan 9, 2026

Creates .github/copilot-instructions.md to guide GitHub Copilot and developers on project conventions.

File Structure

  • General Principles: Ask-before-assuming policy, code quality standards
  • Coding Standards: Style guidelines, naming conventions, error handling
  • Testing Requirements: Coverage expectations, test quality, AAA pattern
  • Documentation: JSDoc/docstrings, README maintenance, inline comments
  • Architecture: Project structure, design patterns, performance considerations
  • Git Workflow: Commit conventions, PR guidelines, branch management
  • Security: Input sanitization, secrets management, authentication patterns
  • Collaboration: Code review expectations, communication guidelines
  • Accessibility: WCAG compliance, semantic HTML, ARIA labels
  • Performance: Bundle optimization, caching strategies, profiling

The file emphasizes asking clarifying questions before implementation and provides actionable, specific guidance across all development activities.

Original prompt

This section details on the original issue you should resolve

<issue_title>Create Copilot Instructions File</issue_title>
<issue_description>## Objective
Check if a Copilot instruction file exists in the repository, and if not, create one with best practices.

Tasks

  • Search for existing Copilot instruction files in the following locations:
    • .github/copilot-instructions.md
    • .github/copilot.md
    • Root-level instruction files
  • If no file exists, create .github/copilot-instructions.md with:
    • Project-specific context and conventions
    • Coding standards and style guidelines
    • Testing requirements
    • Documentation expectations
    • Architecture patterns used in the project
    • Any clarifying questions policy (e.g., "ask clarifying questions before building plans")
  • Create a pull request with the new instruction file

Acceptance Criteria

  • Instruction file is placed in .github/copilot-instructions.md
  • File contains relevant, actionable guidelines for the project
  • PR is created and ready for review</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: microsoftnorman <108091421+microsoftnorman@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Copilot instructions file with best practices Add GitHub Copilot instructions file Jan 9, 2026
Copilot AI requested a review from microsoftnorman January 9, 2026 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create Copilot Instructions File

2 participants