From 377680ac4c3125b0dfeb715f75b1f85f1919331b Mon Sep 17 00:00:00 2001 From: Michiel Borkent Date: Sat, 10 Aug 2019 09:59:46 +0200 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++ README.md | 7 +----- 3 files changed, 50 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md 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 new file mode 100644 index 00000000..3a14c403 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**version** + +[ Please specify which version of babashka you're using. You can find this with `babashka --version`. The documentation on the master branch may be ahead of the most released version. You can check the docs for your version by going to cljdoc. ] + +**platform** + +[ Please specify which platform you are using babashka on, so you can test a +new binary when the issue is resolved. ] + +**problem** + +[ Please provide a short and to the point description of the problem ] + +**repro** + +[ Please provide a minimal working reproduction of the problem ] + +**expected behavior** + +[ What is the behavior you expected to see? Please provide a minimal working example ] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..bbcbbe7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +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/README.md b/README.md index c948ebd1..604328fc 100644 --- a/README.md +++ b/README.md @@ -55,12 +55,7 @@ There is one special variable, `*in*`, which is the input read from stdin. The input is read as EDN by default, unless the `--raw` flag is provided. When using the `--println` flag, the output is printed using `println` instead of `prn`. -The current version can be printed with: - -``` shellsession -bb --version -0.0.3 -``` +The current version can be printed with `bb --version`. Examples: