From 83313a4a4ef6564abb967d3105ef06ec8a5eeb51 Mon Sep 17 00:00:00 2001 From: Seth Morton Date: Sun, 9 Sep 2018 22:35:47 -0700 Subject: Update issue templates [ci skip] --- .github/ISSUE_TEMPLATE/bug_report.md | 23 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 7 +++++++ 3 files changed, 44 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..caebd68 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Report unexpected behavior, a crash, or incorrect results + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment (please complete the following information):** + - Python Version: [e.g. 3.6] + - OS [e.g. Windows, Fedora] + - If the bug involves `LOCALE` or `humansorted`: + - Is `PyICU` installed? + - Do you have a locale set? If so, to what? + +**To Reproduce** +Include a Minimum, Complete, Verifiable Example. If there is a traceback (or error message), **please** include the *entire* traceback (or error message), even if you think it is too big. + +See https://stackoverflow.com/help/mcve for an explanation. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5024e49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest or request an enhancement + +--- + +**Describe the feature or enhancement** +Be as descriptive and precise as possible. + +**Provide a concrete example of how the feature or enhancement will improve `natsort`** +Code examples are an excellent way to show how this feature or enhancement will help. To make your case stronger, show the current workaround due to the lack of the feature. What is the return-on-investment for including the feature or enhancement? + +**Would you be willing to submit a Pull Request for this feature?** +Extra help is *always* welcome. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..adaf5c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,7 @@ +--- +name: Question +about: Inquiry about natsort + +--- + +- [ ] I have read the [`natsort` documentation](https://natsort.readthedocs.io/en/master/) and the [README](https://github.com/SethMMorton/natsort#natsort), and my question is still not answered -- cgit v1.2.1