From 0765ed6efcd389f3c055de1dce0e2061b8a1243b Mon Sep 17 00:00:00 2001 From: tituspijean Date: Fri, 10 Dec 2021 20:09:03 +0100 Subject: [PATCH 1/5] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 54 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 12 +++++ 2 files changed, 66 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..deaa9e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,54 @@ +--- +name: Bug report +about: Report unwanted behaviour of YunoHost's webadmin, CLI, features... +title: '' +labels: ":space_invader: bug" +assignees: '' + +--- + +### Describe the bug + + + + +### Context + +- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* +- YunoHost version: x.x.x +- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* +- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* + - If yes, please explain: +- Using, or trying to install package version/branch: +- If upgrading, current YunoHost version: + +### To reproduce + + + +### Expected behavior + + + +### Logs + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2c25bdd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,12 @@ +--- +name: Feature request +about: Suggest an idea for YunoHost +title: '' +labels: ":birthday: feature" +assignees: '' + +--- + + + + From 9980aa90bbe467355c08c06123ff51a9a06cd3c8 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Fri, 10 Dec 2021 20:13:05 +0100 Subject: [PATCH 2/5] Update README --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d25b187..03242e5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ -# issues -General issue tracker for the YunoHost project +# Issues +This is the general issue tracker for the YunoHost project -**/!\ If you have found a security issue, please follow https://yunohost.org/en/security_team** +**:warning: If you have found a security issue, refer to our [secury team](https://yunohost.org/security_team).** +Please read carefully the issue template and the following guide. + +Let's determine if you are on the right place: + - If your bug relates to an app provided by YunoHost (install, update, backup, restore, change url...), we prefer that you post your issue on their own issue tracker in the [YunoHost-Apps](https://github.com/YunoHost-Apps) organisation. If your app is called Example, look for the "example_ynh" repository. + - If you were performing an action from the webadmin or the CLI and want some support, you can post about it on our forum (https://forum.yunohost.org/) or our chat room (https://yunohost.org/help). + - If you were performing an action from the webadmin or the CLI and encountered what you think is a bug, you are on the right place! Carefully follow the issue template, for better efficiency. + - If you want to request an app to be packaged for YunoHost, please refer to the [apps wishlist](https://yunohost.org/apps_wishlist). You can [add it](https://github.com/yunohost/doc/blob/master/pages/02.applications/04.wishlist/apps_wishlist.md) if it is not already listed. + - If you are requesting a feature for YunoHost, you are on the right place! You can overlook most of the bug report template, but be as precise as possible in your description of the feature. + - When in doubt, post here and we will figure it out together. From 165a2408326dfec0915deb5d424623595dc8553c Mon Sep 17 00:00:00 2001 From: tituspijean Date: Fri, 10 Dec 2021 20:13:30 +0100 Subject: [PATCH 3/5] Configure templates and links --- .github/ISSUE_TEMPLATE/config.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ed0843a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: true +contact_links: + - name: YunoHost community support + url: https://yunohost.org/help + about: General support questions are welcomed on our forum or chatrooms on IRC, XMPP, and Matrix + - name: YunoHost security + url: https://yunohost.org/security_team + about: Please report security vulnerabilities here. + - name: Bug in an app + url: https://github.com/YunoHost-Apps + about: Report bugs in packaged apps in their own repository + - name: App request + url: https://yunohost.org/apps_wishlist + about: Checkout the apps wishlist (you can edit it!) From faf79173e55dcc018839775efe1112a43813b421 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Fri, 10 Dec 2021 20:14:46 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 03242e5..a6e55a9 100644 --- a/README.md +++ b/README.md @@ -10,5 +10,5 @@ Let's determine if you are on the right place: - If you were performing an action from the webadmin or the CLI and want some support, you can post about it on our forum (https://forum.yunohost.org/) or our chat room (https://yunohost.org/help). - If you were performing an action from the webadmin or the CLI and encountered what you think is a bug, you are on the right place! Carefully follow the issue template, for better efficiency. - If you want to request an app to be packaged for YunoHost, please refer to the [apps wishlist](https://yunohost.org/apps_wishlist). You can [add it](https://github.com/yunohost/doc/blob/master/pages/02.applications/04.wishlist/apps_wishlist.md) if it is not already listed. - - If you are requesting a feature for YunoHost, you are on the right place! You can overlook most of the bug report template, but be as precise as possible in your description of the feature. + - If you are requesting a feature for YunoHost, you are on the right place! Use the dedicated template and be as precise as possible in your description of the feature. - When in doubt, post here and we will figure it out together. From 4b0f0231d1677a5e8111f050fae4d69fbff36e89 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Fri, 10 Dec 2021 20:15:42 +0100 Subject: [PATCH 5/5] Remove old issue template --- issue_template.md | 59 ----------------------------------------------- 1 file changed, 59 deletions(-) delete mode 100644 issue_template.md diff --git a/issue_template.md b/issue_template.md deleted file mode 100644 index a136c53..0000000 --- a/issue_template.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -name: Bug report -about: When creating a bug report, please use the following template to determine if you are at the right place, provide all the relevant information and help debugging efficiently. - ---- - -**/!\ If you have found a security issue, please follow https://yunohost.org/en/security_team** - -**How to post a meaningful bug report** -1. *Read this whole template first.* -2. *Determine if you are on the right place:* - - *If your bug relates to an app provided by YunoHost (install, update, backup, restore, change url...), we prefer that you post your issue on their own issue tracker in the YunoHost-Apps organisation. If your app is called Example, look for the "example_ynh" repository.* - - *If you were performing an action from the webadmin or the CLI and want some support, you can post about it on our forum (https://forum.yunohost.org/) or our chat room (https://yunohost.org/help).* - - *If you were performing an action from the webadmin or the CLI and encountered what you think is a bug, you are on the right place!* - - *If you are requesting a feature for YunoHost, you are on the right place! You can overlook most of the bug report template below, but be as precise as possible in your description of the feature.* - - *When in doubt, post here and we will figure it out together.* -3. *Delete the italic comments as you write over them below, and remove this guide.* ---- - -### Describe the bug - -*A clear and concise description of what the bug is.* - -### Context - -- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* -- YunoHost version: x.x.x -- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* -- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* - - If yes, please explain: -- Using, or trying to install package version/branch: -- If upgrading, current YunoHost version: *can be found in the admin, or with `yunohost -v`* - -### Steps to reproduce - -- *If you performed a command from the CLI, the command itself is enough. For example:* - ```sh - sudo yunohost backup list - ``` -- *If you used the webadmin, please perform the equivalent command from the CLI first.* -- *If the error occurs in your browser, explain what you did:* - 1. *Go to '...'* - 2. *Click on '...'* - 3. *Scroll down to '...'* - 4. *See error* - -### Expected behavior - -*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* - -### Logs - -*When an operation fails, YunoHost provides a simple way to share the logs.* -- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* -- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* - -*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* - -*If applicable and useful, add screenshots to help explain your problem.*