From f8432cf78f68e5adf203ad5cefaaf6244650b4d1 Mon Sep 17 00:00:00 2001 From: Alec Thomas <alec@swapoff.org> Date: Tue, 23 Jul 2019 09:39:56 +1000 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 41774b3..34ea08e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,13 +9,13 @@ assignees: '' **Describe the bug** -A clear and concise description of what the bug is. +A clear and concise description of what the bug is. Screenshots are often helpful here. Do *NOT* just paste a link to other issues on GitHub. **To Reproduce** 1. Provide copyable *text* (not an image) that reproduces the issue. -2. Provide a `chroma` command-line invocation to reproduce the issue with the above text. +2. Provide a `chroma` command-line invocation to reproduce the issue with the above input text. eg. for Hugo the (rough) equivalent would be `chroma -s monokailight --html --html-lines --html-lines-table --html-inline-styles <source>` Do *NOT* provide configuration for another tool (eg. Hugo). My time is limited and if you want me to fix your issue, help me help you. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..99c5822 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**What problem does this feature solve?** + +Please check the Chroma [README](https://github.com/alecthomas/chroma) and command-line tool to ensure this isn't an already solved problem. + +**What feature do you propose?**