From 48eeb421ad6cd9560ec3003128ad32bc67119250 Mon Sep 17 00:00:00 2001 From: stdevCbermudez Date: Fri, 12 Apr 2019 18:19:13 -0400 Subject: [PATCH] [githug] refs #7 - Add github templates --- .github/ISSUE_TEMPLATE/bug_report.md | 80 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 32 +++++++++ .github/issue_template.md | 27 -------- 3 files changed, 112 insertions(+), 27 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..d8753a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,80 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of the problem and bug effects. + +**Environment information:** + +- Platform: the equivalent of `uname -smr` or `uname -smrv` e.g. Darwin 17.4.0 x86_64 +- Go environment: + +``` +# Output of goenv e.g. +$ go env +GOARCH="amd64" +GOBIN="" +GOCACHE="/Users/$USER/Library/Caches/go-build" +GOEXE="" +GOFLAGS="" +GOHOSTARCH="amd64" +GOHOSTOS="darwin" +GOOS="darwin" +GOPATH="/path/to/gopath" +GOPROXY="" +GORACE="" +GOROOT="/usr/local/Cellar/go/1.11/libexec" +GOTMPDIR="" +GOTOOLDIR="/usr/local/Cellar/go/1.11/libexec/pkg/tool/darwin_amd64" +GCCGO="gccgo" +CC="clang" +CXX="clang++" +CGO_ENABLED="1" +GOMOD="" +CGO_CFLAGS="-g -O2" +CGO_CPPFLAGS="" +CGO_CXXFLAGS="-g -O2" +CGO_FFLAGS="-g -O2" +CGO_LDFLAGS="-g -O2" +PKG_CONFIG="pkg-config" +GOGCCFLAGS="-fPIC -m64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/mn/3604lp_57sg1c707mvclltm80000gn/T/go-build917640487=/tmp/go-build -gno-record-gcc-switches -fno-common" +``` + +- Compiler info: + +``` +# something like the output of `gcc --version` e.g. +$ gcc --version +Configured with: --prefix=/Library/Developer/CommandLineTools/usr --with-gxx-include-dir=/usr/include/c++/4.2.1 +Apple LLVM version 9.1.0 (clang-902.0.39.2) +Target: x86_64-apple-darwin17.4.0 +Thread model: posix +InstalledDir: /Library/Developer/CommandLineTools/usr/bin +``` + +**Steps to Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Run '....' +3. Write data to '....' +4. See error + +**Actual behavior** +Explain the failure modes and effects, everything indicating the existence of the bug. +If applicable, add screenshots to help explain your problem. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here. + +**Possible implementation** +Hints to fix the bug. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..1693fa1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,32 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'feature' +assignees: '' + +--- + +**Feature description** + +Describe the feature + +**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 about the problem here. + +**Possible implementation** +Preliminary ideas to get this done. +If you have all details in mind then provide a checklist + +- [ ] Start with ... +- [ ] When done do ... +- [ ] Finally ... diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 4553234..0000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,27 +0,0 @@ - -Issue tracker is **ONLY** used for reporting bugs, features and enhancements. NO SUPPORT TICKETS ACCEPTED! Use [stackoverflow](https://stackoverflow.com) for supporting issues. - -## Expected Behavior - - -## Actual Behavior - - -## Steps to Reproduce the Problem - - - - 1. - 1. - 1. - -## Specifications - - - Version: - - Platform: - - Subsystem: - -## Possible Solution - - -