Skip to content

Commit 1bcb0bd

Browse files
authored
docs: explanatory issue and pull request templates (#186)
1 parent af7cd87 commit 1bcb0bd

5 files changed

Lines changed: 26 additions & 29 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,34 @@ body:
66
- type: markdown
77
attributes:
88
value: >-
9-
Title: describe the observable failure or regression in sentence case,
9+
Title: the observable failure or regression in sentence case,
1010
without a category prefix or terminal punctuation.
1111
Example: `Duplicate submissions can strand callers until deadline`
1212
- type: textarea
1313
id: problem
1414
attributes:
1515
label: Problem
16-
description: What happened? Include the relevant error or diagnostic evidence.
16+
description: What happened? Relevant errors or diagnostic evidence help explain the failure.
1717
validations:
1818
required: true
1919
- type: textarea
2020
id: reproduction
2121
attributes:
2222
label: Reproduction
23-
description: Give the smallest reproduction when known. Note if the failure is intermittent.
23+
description: Smallest known reproduction and whether the failure is intermittent.
2424
validations:
2525
required: false
2626
- type: textarea
2727
id: expected
2828
attributes:
2929
label: Expected
30-
description: Describe what should happen instead when it is not already clear from the problem.
30+
description: What should happen instead, when not already clear from the problem?
3131
validations:
3232
required: false
3333
- type: textarea
3434
id: context
3535
attributes:
3636
label: Context
37-
description: Add the revision, crate or path, and environment details when known and relevant.
37+
description: Relevant revision, crate or path, and environment details, when known.
3838
validations:
3939
required: false

‎.github/ISSUE_TEMPLATE/change_request.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ body:
66
- type: markdown
77
attributes:
88
value: >-
9-
Title: start with an imperative verb and describe the requested outcome
10-
in sentence case, without a category prefix or terminal punctuation.
11-
Example: `Add validator restart coverage`
9+
Title: the requested outcome in sentence case, without a category prefix
10+
or terminal punctuation.
11+
Example: `Validator restart coverage`
1212
- type: textarea
1313
id: goal
1414
attributes:
@@ -27,6 +27,6 @@ body:
2727
id: scope
2828
attributes:
2929
label: Scope
30-
description: Add boundaries or implementation scope when known and not already clear from the goal.
30+
description: Known boundaries or implementation scope not already clear from the goal.
3131
validations:
3232
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ body:
55
- type: markdown
66
attributes:
77
value: >-
8-
Title: state the decision or unknown concisely in sentence case,
8+
Title: the decision or unknown in sentence case,
99
without a category prefix or terminal punctuation.
10-
Example: `Determine whether snapshots require versioned manifests`
10+
Example: `Whether snapshots require versioned manifests`
1111
- type: textarea
1212
id: question
1313
attributes:
@@ -19,13 +19,13 @@ body:
1919
id: context
2020
attributes:
2121
label: Context
22-
description: Add background or prior findings when they help explain the question.
22+
description: Background or prior findings that help explain the question.
2323
validations:
2424
required: false
2525
- type: textarea
2626
id: desired-output
2727
attributes:
2828
label: Desired output
29-
description: Specify an answer, recommendation, prototype, or other artifact when not already clear from the question.
29+
description: An answer, recommendation, prototype, or other artifact, when not already clear from the question.
3030
validations:
3131
required: false

‎.github/ISSUE_TEMPLATE/task.yml‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,22 @@ body:
66
- type: markdown
77
attributes:
88
value: >-
9-
Make the intended outcome clear from the title.
9+
Title: the intended outcome.
1010
- type: textarea
1111
id: scope
1212
attributes:
1313
label: Scope
1414
description: >-
15-
Add details beyond the outcome only when useful: what needs to change,
16-
why, and where it belongs. Introduce new
17-
concepts before using them; do not assume familiarity with related work.
18-
Link to relevant code or design context when useful.
15+
Useful context beyond the outcome: what needs to change, why, and where
16+
it belongs, with links to relevant code or design context.
1917
validations:
2018
required: false
2119
- type: textarea
2220
id: outcome
2321
attributes:
2422
label: Outcome
2523
description: >-
26-
Describe the observable result that defines completion, with enough
24+
The observable result that defines completion, with enough
2725
context to understand the task on its own.
2826
validations:
2927
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
11
<!--
2-
Title: use `<type>: <description>`, with a Conventional Commit type and a
3-
concise lowercase imperative description, without terminal punctuation.
4-
Example: `feat: add state replicator crate`
2+
Title: `<type>: <description>`, with a Conventional Commit type and a
3+
concise lowercase description, without terminal punctuation.
4+
Example: `refactor: simpler error handling`
55
-->
66

77
## What changed
8-
<!-- Summarize the change at the immediate-parent diff boundary. -->
8+
<!-- What changed relative to the immediate parent, and why. Explanatory prose, not instructions. -->
99

10-
<!-- Replace ISSUE with the dedicated issue number. -->
10+
<!-- Dedicated issue completed by this PR, when applicable. -->
1111
Closes #ISSUE
1212

1313
<!--
14-
Impact and Reviewer notes are optional. Include only relevant, non-obvious
15-
information; do not narrate the code. Omit either section when it adds no value,
16-
including for routine chores such as dependency updates or typo fixes.
14+
Impact and Reviewer notes are optional: relevant, non-obvious information only,
15+
without a code inventory. Routine chores may need neither section.
1716
-->
1817

1918
## Impact
20-
<!-- Note behavior, API, storage, compatibility, security, or performance effects. -->
19+
<!-- Behavior, API, storage, compatibility, security, or performance effects. -->
2120

2221
## Reviewer notes
23-
<!-- Point reviewers to invariants, sharp edges, or the highest-risk part of the diff. -->
22+
<!-- Invariants, sharp edges, or the highest-risk part of the diff. -->

0 commit comments

Comments
 (0)