Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Nothing here is a gate.
#
# The templates beside this file are prompts for a person. Keeping the blank issue
# available is what makes the first line of each of them true: a form nobody can
# walk past is enforcement whatever it says about itself, and somebody with
# something to report that fits neither template should not be turned away by a
# heading.
#
# No contact links. A link here publishes a route to a person, and which address
# this repository publishes, for a vulnerability or for anything else, is entry 5
# of #1 and is not decided.
blank_issues_enabled: true
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/decision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
name: Something here has to be decided
about: A question this repository has to answer before code depends on the answer
title: ''
labels: ''
assignees: ''
---

<!--
Nothing reads this template. No check parses it, no heading is required, and an
issue that deletes the whole thing and states the question in three sentences
passes every check on this repository. It is a prompt for a person, not a gate,
and it is written down here so that nobody mistakes a filled-in form for a
checked one.

Delete these comments and the guidance under each heading as you fill it in.
-->

## What is undecided

<!--
The question, in one sentence, and what in this repository is waiting on it.

A question nothing is waiting on can be answered later and more cheaply, so say
what stops if it stays open. Where the answer is not yours to give, say whose it
is rather than proposing one.
-->

## The options, and what each costs

<!--
Every option genuinely on the table, each with what choosing it costs rather than
what makes it attractive.

An option listed only so that it can be dismissed in the same sentence teaches a
later reader nothing, and the reader this heading exists for is the one proposing
that option again in a year.

Numbers carry their commands here as everywhere else:

<the command>
<its output>
-->

## What the answer forecloses

<!--
Each option makes one of the others expensive to reach later. Say which.

This is the part that is invisible at the moment of choosing and permanent
afterwards, and it is the reason the question is worth an issue rather than a
sentence in a pull request.
-->

## What done means

<!--
Where the answer ends up, and what changes once it is there. Usually a record
under `docs/decisions/`, plus every issue that named this one as what it was
waiting for.

The shape a record takes, including the reversal condition every one of them
carries, is in `docs/decisions/0001-decision-records.md`. Do not restate it here;
a second copy of a format is a copy that drifts.
-->
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/problem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
name: Something here is wrong
about: A defect, a gap, or a rule with nothing behind it
title: ''
labels: ''
assignees: ''
---

<!--
Nothing reads this template. No check parses it, no heading is required, and an
issue that deletes the whole thing and says what is wrong in three sentences
passes every check on this repository. It is a prompt for a person, not a gate,
and it is written down here so that nobody mistakes a filled-in form for a
checked one.

Delete these comments and the guidance under each heading as you fill it in.
-->

## What is wrong

<!--
The thing that is wrong, in the words somebody reading this in a year would use.

Where it is a gap rather than a defect, say what a reader expects to find and
what they find instead. Where it is a rule with nothing behind it, say which
sentence claims the rule and which check was supposed to refuse the violation.
-->

## The evidence

<!--
What you saw, rather than what you concluded from it.

Every number here carries the command that produced it, pasted with its output,
run against the reference a reader will have rather than against a working tree
that has something else in it:

<the command>
<its output>

That means every number. A count, a duration, a size, a version, a percentage,
how many files something touches. A sentence with a number and no command is a
claim, and the difference between a claim and evidence is one line.

Where a claim cannot be backed by a command, write it as a claim and say so,
rather than writing it as a measurement.
-->

## What done means

<!--
The condition under which this issue closes, written so that somebody other than
you can look at the repository and say whether it has been met.

"Handle this better" is not such a condition. A command that answers differently,
a file that exists, a check that refuses something it accepts today, or a test
that reddens when a guard is deleted, are.

Where what is being asked for is a guard, say what it has to refuse. A guard
nobody has watched fail is a guard nobody knows the direction of.
-->

## What this waits on

<!--
Anything this cannot move without: another issue, a decision nobody has taken, a
setting on the repository that no branch can change. Naming it here is what lets
a reader tell an issue that is ready from one that is waiting, without opening
every issue it mentions.

Delete this heading if it waits on nothing.
-->
Loading