From 55f85203077e2be3f25d9a4f384fe92837331679 Mon Sep 17 00:00:00 2001 From: "Andreas M. Antonopoulos" Date: Thu, 6 Feb 2020 08:04:19 -0600 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/editorial.md | 12 +++++++++++- .github/ISSUE_TEMPLATE/feature_request.md | 20 -------------------- .github/ISSUE_TEMPLATE/help-me-understand.md | 19 +++++++++++++++++++ 3 files changed, 30 insertions(+), 21 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/help-me-understand.md diff --git a/.github/ISSUE_TEMPLATE/editorial.md b/.github/ISSUE_TEMPLATE/editorial.md index 1c5412a..649c53f 100644 --- a/.github/ISSUE_TEMPLATE/editorial.md +++ b/.github/ISSUE_TEMPLATE/editorial.md @@ -2,9 +2,19 @@ name: Editorial about: 'Editorial changes: Keep/Drop, Simplify, Expand, Re-write, Re-organize, Move' title: 'Editorial: [Keep/Drop, Simplify, Expand, Re-write, Re-organize, Move] ' -labels: '' +labels: editorial assignees: '' --- +**Which part needs editing?** +Which part of the book needs editing? Filename, line? +**What editing does this need?** +Some options: Keep/Drop, Simplify, Expand, Re-write, Re-organize, Move + +**How does it currently read?** +Copy the text that needs editing, if it is small enough + +**How should it read?** +Write a recommended solution here, if you can! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/help-me-understand.md b/.github/ISSUE_TEMPLATE/help-me-understand.md new file mode 100644 index 0000000..4f2f75d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help-me-understand.md @@ -0,0 +1,19 @@ +--- +name: Help Me Understand +about: 'Help Me Understand: [Explain More, Example, Clarification, Wording, Diagram, + Code Sample, Story]' +title: 'Help Me Understand: [Explain More, Example, Clarification, Wording, Diagram, + Code Sample, Story]' +labels: question +assignees: '' + +--- + +**Which topic needs more explanation?** +Identify the topic area that needs more explanation and where it is currently in the book + +**What about the topic is not understood?** +Tell us which part is difficult to understand + +**What does this topic needs to be easier to understand?** +Does this topic needs more explanation? An example? Clarification? Better wording? A diagram? A story? A code sample?