alunduil / alunduil/zfs-replicate

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

Open
#421 1 comment 0 reactions 0 assignees View on GitHub
enhancement good first issue
Dominant language
Python
Stars
24
Forks
6
Avg merge
3h 11m
Merged PRs (30d)
49

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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.