diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index ce62829d..925f1437 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,36 +1,51 @@ -Thank you for submitting an issue for STF! + - +Please be sure to run `stf doctor` before submitting an issue. Please include screenshots, command output and log files if any. -## Current Behavior +=== SUPER COMMON QUESTIONS === + +Q. I'm having issues when multiple devices are connected. +A. Usually caused by insufficient USB power supply or other hardware issue we can't do anything about. + +Q. Can I connect a device to STF over WIFI? +A. Yes, with the `--allow-remote` option. However, ADB over WIFI can easily be 10x slower than USB, so don't expect too much. + +Q. How do I connect to my local STF from another computer? +A. Try the `--public-ip` option or do a full deployment. See DEPLOYMENT.md in the doc folder. + +Q. Can I run STF on multiple machines? +A. Yes, if you do a full deployment. See DEPLOYMENT.md in the doc folder. +--> + +## What's the problem (or question)? -## Possible Solution +## What should have happened? + + + +## Do you have an idea for a solution? -## Steps to Reproduce (for bugs) +## How can we reproduce the issue? 1. 2. 3. 4. -## Context +## Help us understand your issue by providing context. -## Your Environment +## Please tell us details about your environment. -* Local deployment or Cluster deployment? -* Version used: -* Environment name and version (e.g. Chrome 39, node.js 5.4): -* Operating System and version: -* If there was a problem with a specific device, include model number and the according logs: +* Are you using `stf local` or a [full deployment](doc/DEPLOYMENT.md): +* Version used (git hash or `stf -V`): +* Environment name and version (e.g. Chrome 39, node.js 5.4): +* Operating System and version: +* If there was a problem with a specific device, run `adb devices -l` and paste the relevant row here: