From 0550a9a460aac7e5cd449513fed0567e558d2891 Mon Sep 17 00:00:00 2001 From: Andrey Meshkov <am@adguard.com> Date: Fri, 2 Aug 2019 13:33:36 +0300 Subject: [PATCH] *(documentation): Github issue template --- .github/ISSUE_TEMPLATE/Bug_report.md | 47 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 28 ++++++++++++++ .github/stale.yml | 19 +++++++++ issue_template.md | 35 ----------------- 4 files changed, 94 insertions(+), 35 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/stale.yml delete mode 100644 issue_template.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 00000000..b542fee9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,47 @@ +--- +name: Bug report +about: Create a bug report to help us improve AdGuard Home + +--- + +<!-- As an open source project with a dedicated but small maintainer team, it can sometimes take a long time for issues to be addressed so please be patient and we will get back to you as soon as we can. +--> + +### Prerequisites + +Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.** + +- [ ] I am running the latest version +- [ ] I checked the documentation and found no answer +- [ ] I checked to make sure that this issue has not already been filed + +### Issue Details + +<!--- Please include all relevant details about the environment you experienced the bug in --> + +* **Version of AdGuard Home server:** + * <!-- (e.g. v1.0) --> +* **How did you setup DNS configuration:** + * <!-- (System/Router/IoT) --> +* **If it's a router or IoT, please write device model:** + * <!-- (e.g. Raspberry Pi 3 Model B) --> +* **Operating system and version:** + * <!-- (e.g. Ubuntu 18.04.1) --> + +### Expected Behavior +<!-- A clear and concise description of what you expected to happen. --> + +### Actual Behavior +<!-- A clear and concise description of what actually happened. --> + +### Screenshots +<!-- If applicable, add screenshots to help explain your problem. --> + +<details><summary>Screenshot:</summary> + +<!--- drag and drop, upload or paste your screenshot to this area--> + +</details> + +### Additional Information +<!-- Add any other context about the problem here. --> diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 00000000..8a9629ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature request +about: Suggest an idea for Electron + +--- + +<!-- As an open source project with a dedicated but small maintainer team, it can sometimes take a long time for issues to be addressed so please be patient and we will get back to you as soon as we can. +--> + +### Prerequisites + +Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.** + +- [ ] I am running the latest version +- [ ] I checked the documentation and found no answer +- [ ] I checked to make sure that this issue has not already been filed + +### Problem Description +<!-- Is your feature request related to a problem? Please add a clear and concise description of what the problem is. --> + +### Proposed Solution +<!-- Describe the solution you'd like in a clear and concise manner --> + +### Alternatives Considered +<!-- A clear and concise description of any alternative solutions or features you've considered. --> + +### Additional Information +<!-- Add any other context about the problem here. --> diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 00000000..fa56e823 --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,19 @@ +# Number of days of inactivity before an issue becomes stale +daysUntilStale: 60 +# Number of days of inactivity before a stale issue is closed +daysUntilClose: 7 +# Issues with these labels will never be considered stale +exemptLabels: + - 'bug' + - 'enhancement' + - 'feature request' + - 'localization' +# Label to use when marking an issue as stale +staleLabel: 'wontfix' +# Comment to post when marking an issue as stale. Set to `false` to disable +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. +# Comment to post when closing a stale issue. Set to `false` to disable +closeComment: false diff --git a/issue_template.md b/issue_template.md deleted file mode 100644 index bb020c5e..00000000 --- a/issue_template.md +++ /dev/null @@ -1,35 +0,0 @@ -<!--- Help us to avoid duplicate reports, make sure you have searched through existing issues before submitting a new one--> - - -<!--- If you are requesting a new feature, tell us how it should work in free form--> -<!--- If you are reporting a bug, submit the detailed description using the template below--> - -### Steps to reproduce -<!--- Provide a link to a live example or a clear set of steps to reproduce the issue--> -1. -2. -3. -4. - -### Expected behavior -<!--- Tell us what should happen --> - -### Actual behavior -<!--- Tell us what happens instead --> - - -<details><summary>Screenshot:</summary> - -<!--- drag and drop, upload or paste your screenshot to this area--> - -</details> - -### Your environment -<!--- Please include all relevant details about the environment you experienced the bug in --> - -| Description | Value | -| -------------- | ------------ | -| Version of AdGuard Home server:| (e.g. v1.0) -| How did you setup DNS configuration:| (System/Router/IoT) -| If it's a router or IoT, please write device model:| (e.g. Raspberry Pi 3 Model B) -| Operating system and version:| (e.g. Ubuntu 18.04.1)