Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.
This repository was archived by the owner on Oct 10, 2025. It is now read-only.

Create custom instructions for GitHub Copilot #8

@josecelano

Description

@josecelano

To improve the quality and relevance of suggestions from GitHub Copilot, we should create a repository-specific custom instructions file. This file will provide Copilot with essential context about our project's goals, technical stack, and conventions.

Following the official GitHub documentation, we will create a .github/copilot/instructions.md file to guide the LLM's behavior when working within this repository.

Action Items

  1. Create the necessary directory structure: .github/copilot/.
  2. Create a new file named instructions.md within the .github/copilot/ directory.
  3. Populate instructions.md with key information about this repository, including:
    • The overall purpose: providing a demo setup for the Torrust Tracker.
    • The current major initiative: migrating the tracker to a new infrastructure on Hetzner.
    • The chosen architecture: a native (non-Docker) tracker binary with supporting services (Nginx, Prometheus, MySQL) running in Docker.
    • The desired persona for interactions: an experienced open-source developer and system administrator.
    • Project conventions, such as the use of Conventional Commits for commit messages.

Reference

https://docs.github.com/en/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot

cc @da2ce7

Metadata

Metadata

Assignees

Labels

- Agents -Improve context for LLms- Developer -Torrust Improvement Experience

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions