diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f06d040 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,25 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +# Submitting Issues + +Please only submit reproducible issues and write the instructions on how to reproduce them. + +When you are submitting a new issue, please supply the following information: + +* **Version info;** Copy the data inside the Info.txt file (`/home/pi/E-Paper-Master/Info.txt`). If there's no such file, you are using an outdated version. Please consider updating. + +* **Error output:** Any errors of the Main script can be found in `/home/pi/E-Paper-Master/E-Paper-err.log`. You don't need to copy the entire file (please don't) but rather the latest errors that occured. + +* **Changes made:** If you have made any changes (apart from personal information), also include them to help debugging. + +* **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem. + +* **Steps to reproduce:** List the step by step process to reproduce the issue. + +* **Results**: Describe what you expected to see and what you actually saw. + +* **Additional Notes:** Provide any other relevant notes not previously mentioned. This is optional.