From 7309a53356dae9870e1b09cf4cb1829badfabb71 Mon Sep 17 00:00:00 2001 From: Ainar Garipov Date: Wed, 14 Jun 2023 13:09:09 +0300 Subject: [PATCH] Pull request 1874: upd-github-templates Merge in DNS/adguard-home from upd-github-templates to master Squashed commit of the following: commit 713a98668e5ee1fa3d64881496043b499ad6ac09 Author: Ainar Garipov Date: Tue Jun 13 20:10:35 2023 +0300 all: imp github issue templates more commit 308a3fcd5564d7536b6ae1192cd17c04b6752ea1 Author: Ainar Garipov Date: Tue Jun 13 19:38:28 2023 +0300 all: imp issue tmpls --- .github/ISSUE_TEMPLATE/bug.yml | 130 ++++++++++++++------- .github/ISSUE_TEMPLATE/feature.yml | 35 ++++-- .github/PULL_REQUEST_TEMPLATE | 20 ++++ .github/workflows/potential-duplicates.yml | 18 +++ 4 files changed, 147 insertions(+), 56 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE create mode 100644 .github/workflows/potential-duplicates.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index a5c40e4f..98db03e0 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -10,52 +10,58 @@ - 'label': > I have checked the [Wiki](https://github.com/AdguardTeam/AdGuardHome/wiki) and - [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions) + [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a) and found no answer 'required': true - 'label': > I have searched other issues and found no duplicates 'required': true - 'label': > - I want to report a bug and not ask a question + I want to report a bug and not [ask a question or ask for + help](https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a) + 'required': true + - 'label': > + I have set up AdGuard Home correctly and [configured clients to + use it](https://github.com/AdguardTeam/AdGuardHome/wiki/Clients). + (Use the + [Discussions](https://github.com/AdguardTeam/AdGuardHome/discussions/categories/q-a) + for help with installing and configuring clients.) 'required': true 'id': 'prerequisites' 'type': 'checkboxes' - 'attributes': - 'description': 'On which operating system type does the issue occur?' - 'label': 'Operating system type' + 'description': 'On which Platform does the issue occur?' + 'label': 'Platform (OS and CPU architecture)' 'options': - - 'FreeBSD' - - 'Linux, OpenWrt' - - 'Linux, Other (please mention the version in the description)' - - 'macOS (aka Darwin)' - - 'OpenBSD' - - 'Windows' - - 'Other (please mention in the description)' + - 'Darwin (aka macOS)/AMD64 (aka x86_64)' + - 'Darwin (aka macOS)/ARM64' + - 'FreeBSD/386' + - 'FreeBSD/AMD64 (aka x86_64)' + - 'FreeBSD/ARM64' + - 'FreeBSD/ARMv5' + - 'FreeBSD/ARMv6' + - 'FreeBSD/ARMv7' + - 'Linux/386' + - 'Linux/AMD64 (aka x86_64)' + - 'Linux/ARM64' + - 'Linux/ARMv5' + - 'Linux/ARMv6' + - 'Linux/ARMv7' + - 'Linux/MIPS LE' + - 'Linux/MIPS' + - 'Linux/MIPS64 LE' + - 'Linux/MIPS64' + - 'Linux/PPC64 LE' + - 'OpenBSD/AMD64 (aka x86_64)' + - 'OpenBSD/ARM64' + - 'Windows/386' + - 'Windows/AMD64 (aka x86_64)' + - 'Windows/ARM64' + - 'Custom (please mention in the description)' 'id': 'os' 'type': 'dropdown' 'validations': 'required': true - - 'attributes': - 'description': 'On which CPU architecture does the issue occur?' - 'label': 'CPU architecture' - 'options': - - 'AMD64' - - 'x86' - - '64-bit ARM' - - 'ARMv5' - - 'ARMv6' - - 'ARMv7' - - '64-bit MIPS' - - '64-bit MIPS LE' - - '32-bit MIPS' - - '32-bit MIPS LE' - - '64-bit PowerPC LE' - - 'Other (please mention in the description)' - 'id': 'arch' - 'type': 'dropdown' - 'validations': - 'required': true - 'attributes': 'description': 'How did you install AdGuard Home?' 'label': 'Installation' @@ -63,7 +69,7 @@ - 'GitHub releases or script from README' - 'Docker' - 'Snapcraft' - - 'Custom port' + - 'Custom package (OpenWrt, HomeAssistant, etc; please mention in the description)' - 'Other (please mention in the description)' 'id': 'install' 'type': 'dropdown' @@ -89,21 +95,55 @@ 'validations': 'required': true - 'attributes': - 'description': 'Please describe the bug' - 'label': 'Description' + 'description': > + Please describe what you did. An `nslookup` or a `dig` command is + the best way. For crashes, please provide a full failure log. + 'label': 'Action' 'value': | - #### What did you do? - - #### Expected result - - #### Actual result - - #### Screenshots (if applicable) - - #### Additional information - 'id': 'description' + ```sh + nslookup -debug -type=a 'www.example.com' '$YOUR_AGH_ADDRESS' + ``` + 'id': 'failing_action' 'type': 'textarea' 'validations': 'required': true -'description': 'File a bug report' + - 'attributes': + 'description': > + What did you expect to see? Please add a description and/or + screenshots, if applicable. + 'label': 'Expected result' + 'placeholder': > + What did you expect to see? + 'id': 'expected' + 'type': 'textarea' + 'validations': + 'required': true + - 'attributes': + 'description': > + What happened instead? Please add a description and/or screenshots, + if applicable. + 'label': 'Actual result' + 'placeholder': > + What did you see instead? + 'id': 'result' + 'type': 'textarea' + 'validations': + 'required': true + - 'attributes': + 'description': > + Please add additional information, such as non-standard OS or port, + here. You can also put screenshots here, if applicable. For + example, it is better to copy and paste text from a terminal instead + of posting a screenshot of the terminal. + 'label': 'Additional information and/or screenshots' + 'placeholder': > + Additional OS information, screenshots of the UI, etc. + 'id': 'additional' + 'type': 'textarea' + 'validations': + 'required': false +'description': > + Open a bug report. Please do not open bug reports for questions or help + with configuring clients. If you want to ask for help, use the Discussions + section. 'name': 'Bug' diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 0ad6f5d8..154a137d 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -23,19 +23,32 @@ 'id': 'prerequisites' 'type': 'checkboxes' - 'attributes': - 'description': 'Please describe the request' - 'label': 'Description' - 'value': | - #### What problem are you trying to solve? - - #### Proposed solution - - #### Alternatives considered - - #### Additional information - 'id': 'description' + 'description': 'Please describe the problem you are trying to solve' + 'label': 'The problem' + 'placeholder': > + Please describe the problem you are trying to solve + 'id': 'problem' 'type': 'textarea' 'validations': 'required': true + - 'attributes': + 'description': 'What feature are you proposing to solve this problem?' + 'label': 'Proposed solution' + 'placeholder': > + What feature are you proposing to solve this problem? + 'id': 'proposed_solution' + 'type': 'textarea' + 'validations': + 'required': true + - 'attributes': + 'label': 'Alternatives considered and additional information' + 'placeholder': > + Are there any other ways to solve the problem? + 'id': 'additional' + 'type': 'textarea' + 'validations': + 'required': false 'description': 'Suggest a feature or an enhancement for AdGuard Home' +'labels': + - 'feature request' 'name': 'Feature request or enhancement' diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 00000000..d969343d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,20 @@ +Before submitting a PR please make sure that: + +1. You have discussed your solution in an issue and have got an + approval from a maintainer. + +2. This isn't a localization fix; please send those to our + [CrowdIn](https://crowdin.com/project/adguard-applications/en#/adguard-home) + page. + +3. Your code follows our + [code guidelines](https://github.com/AdguardTeam/CodeGuidelines/blob/master/Go/Go.md). + +Add a short description here. The description should include: + +1. Which issue this PR closes (`Closes #NNNN.`) or updates (`Updates + #NNNN.`). + +2. A short description of how the change achieves that. + +Do not forget to remove these instructions. diff --git a/.github/workflows/potential-duplicates.yml b/.github/workflows/potential-duplicates.yml new file mode 100644 index 00000000..dd065845 --- /dev/null +++ b/.github/workflows/potential-duplicates.yml @@ -0,0 +1,18 @@ +'name': 'potential-duplicates' +'on': + 'issues': + 'types': + - 'opened' +'jobs': + 'run': + 'runs-on': 'ubuntu-latest' + 'steps': + - 'uses': 'wow-actions/potential-duplicates@v1' + 'with': + 'GITHUB_TOKEN': '${{ secrets.GITHUB_TOKEN }}' + 'state': 'all' + 'threshold': 0.6 + 'comment': | + Potential duplicates: {{#issues}} + * [#{{ number }}] {{ title }} ({{ accuracy }}%) + {{/issues}}