alunduil/zfs-replicate

.github/copilot-instructions.md redirects to AGENTS.md

Open

#421 opened on Apr 23, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (24 stars)
PR merge metrics
 (PR metrics pending)

Description

User story

As a GitHub Copilot user (Chat, PR review, or the Copilot coding agent), I want .github/copilot-instructions.md to load automatically so that Copilot-generated code follows the same conventions as human- and agent-written code.

Why

GitHub Copilot reads .github/copilot-instructions.md for project-level guidance. Pointing it at AGENTS.md keeps everything in one place.

Acceptance criteria

  • .github/copilot-instructions.md exists.
  • Its body is a one-line redirect: See [AGENTS.md](../AGENTS.md) for repo conventions.
  • Any Copilot-specific guidance (e.g., referencing .github/copilot/*.instructions.md files once they exist) is appended after the redirect.

Out of scope

  • Creating the task-specific instruction/prompt files under .github/copilot/ (separate issue).

Notes

  • Target release: none — chore
  • Depends on AGENTS.md landing first.
  • Source: modernization assessment §6.1.

Contributor guide

Research direction
Create the file `.github/copilot instructions.md` with the one line redirect `See [AGENTS.md](../AGENTS.md) for repo conventions.` If future Copilot specific guidance is needed, append it after that line. Commit and push the file to the main branch.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90