From 3fd3879ae32fa7d5e11d147e3bd1aca30677b5ca Mon Sep 17 00:00:00 2001 From: Andy Grunwald Date: Wed, 29 Apr 2020 08:22:53 +0200 Subject: [PATCH] improvement: Add ISSUE_TEMPLATES to guide users and contributors (for bugs and feature requests) --- .github/ISSUE_TEMPLATE/bug_report.md | 51 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 4 ++ .github/ISSUE_TEMPLATE/feature_request.md | 24 +++++++++++ 3 files changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml 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 0000000..4228558 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,51 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +## Describe the bug + +A clear and concise description of what the bug is. + +Formatting tips: GitHub supports Markdown: https://guides.github.com/features/mastering-markdown/ + +## To Reproduce + +Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include configuration, logs, etc. to reproduce, if relevant. + +1. +2. +3. +4. + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Possible Solution + +Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement: the addition or change. + +## Your Environment + +Include as many relevant details about the environment you experienced the problem in + +* go-jira version (git tag or sha): +* Go version (`go version`): +* Jira version: +* Jira type (cloud or on-premise): +* Involved Jira plugins: +* Operating System and version: + +## Additional context + +Add any other context about the problem here. + +How has this issue affected you? What are you trying to accomplish? +Providing context helps us come up with a solution that is most useful in the real world. + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0dcdd1f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: Report a bug/feature request for the Jira Command Line Client + url: https://github.com/go-jira/jira/issues + about: This is the issue tracker for the Jira command-line client in Go. If you are using this, please report issues there. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..edc78bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +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 using this feature but am missing [...] + +## 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. \ No newline at end of file