alunduil/zfs-replicate

new-issue.prompt.md guides drafters toward the project's issue shape

Open

#429 opened on Apr 23, 2026

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (5 forks)auto 404
enhancementgood first issueno-issue-activity

Repository metrics

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

Description

User story

As a contributor or agent opening an issue, I want a reusable prompt that guides the structure (outcome-oriented title, user story, acceptance criteria, out-of-scope) so that new issues match the shape of the ones created during this modernization pass.

Why

GitHub's Copilot convention uses .prompt.md files for on-demand recipes. A new-issue.prompt.md mirrors the issue-form approach for people drafting issues via an AI tool. Low cost, reinforces consistency.

Acceptance criteria

  • .github/copilot/new-issue.prompt.md exists.
  • Guides the drafter through:
    • Outcome-oriented title ("X can Y so that Z", not "Add X").
    • User story block.
    • Why / context.
    • Acceptance criteria (checked-list).
    • Out of scope (explicit).
    • Notes (target release, dependencies, source).
  • Matches the shape of the issues filed for this plan so style stays consistent.

Out of scope

  • new-command.prompt.md, port-shell-to-typed-command.prompt.md, and other recipes — those are separate issues if/when needed.

Notes

  • Target release: none — chore
  • Source: modernization assessment §6.1.

Contributor guide

Research direction
Create the file `.github/copilot/new issue.prompt.md` following the acceptance criteria: include outcome oriented title, user story, why/context, acceptance criteria (checked list), out of scope, and notes. Ensure the style matches existing issues in the project.
Tech stack
None
Domain
documentationdeveloper experiencetooling
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.
Active
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