diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..db4c0b623 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +Remember, an issue is not the place to ask questions. You can use [Stack Overflow](http://stackoverflow.com/questions/tagged/ibm-watson) for that, or you may want to start a discussion on the [dW Answers](https://developer.ibm.com/answers/questions/ask/?topics=watson). + + Before you open an issue, please check if a similar issue already exists or has been closed before. + + **Check service status** + + 1. For service issues or 5xx errors, first, go to https://console.bluemix.net/status?tags=platform,runtimes,services&view=n:i and check the status of the service. +1. If the service status is OK, continue with a bug report. + + --- + + **Overview** +_What is the issue? Be concise and clear._ + + **Expected behavior** +_What did you expect to happen?_ + + **Actual behavior** +_What actually happened?_ + + **How to reproduce** +_Help us to reproduce what you experienced. Include your code snippets (without credentials)_ + + **Screenshots** +_If applicable, add screenshots to help explain your problem._ + + **SDK Version** +_Please provide the SDK version here._ + + **Additional information:** +- OS: _for example, iOS_ +- Which version of `Node/Ruby/Python/...` are you using? + + **Additional context** +_Add any other details about the problem._ diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..c86f075d1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +Remember, an issue is not the place to ask questions. You can use [Stack Overflow](http://stackoverflow.com/questions/tagged/ibm-watson) for that, or you may want to start a discussion on the [dW Answers](https://developer.ibm.com/answers/questions/ask/?topics=watson). + +Before you open an issue, please check if a similar issue already exists or has been closed before. + +### When you open an issue for a feature request, please add as much detail as possible: + +- [ ] A descriptive title starting with the service name +- [ ] A description of the problem you're trying to solve +- [ ] A suggested solution if possible