Skip to content

[FEATURE]- Add copilot instructions and claude.md file to repository #1391

@ngenovese11

Description

@ngenovese11

Is your feature request related to a problem? Please describe.

We currently don’t have any repository-specific AI assistant guidance (GitHub Copilot instructions) or a claude.md file. This can lead to inconsistent AI-generated changes (coding style and project conventions in particular).

Describe the solution you'd like

Add two repo-level guidance files focused on current, stable conventions:

  1. Copilot instructions
  • Add a Copilot instructions file so Copilot Chat/Agent has clear repo conventions to follow.
  • Suggested location: .github/copilot-instructions.md (or whichever location the maintainers prefer).
  1. Claude instructions
  • Add claude.md at the repository root to provide similar guidance for Claude-based tooling and contributors.

For now, both files could include:

  • Code style conventions (naming, formatting, common patterns used in this repo)
  • Architecture conventions (where code should live, how to structure new components/modules, and preferred patterns within Essentials)

Describe alternatives you've considered

  • Maintain guidance only in the README/wiki.
  • Add guidance in a CONTRIBUTING.md file instead (or in addition).
  • Add only one of the two files (Copilot instructions or claude.md) and expand later if needed.

Additional context

  • Please confirm preferred locations/names:
    • Copilot instructions: .github/copilot-instructions.md (suggested) vs other.
    • Claude: root claude.md.
  • Since some decisions are still evolving, we can keep these files intentionally lightweight and update them over time as conventions solidify.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions