From 730beab8812e796b782a3f10c73732c73c3f84e5 Mon Sep 17 00:00:00 2001 From: Alex Sirota Date: Sat, 2 Nov 2024 10:03:48 -0400 Subject: [PATCH 1/5] adding ISSUE_TEMPLATE helps new GitHub contributors file better bugs or feature requests Signed-off-by: Alex Sirota --- .github/ISSUE_TEMPLATE/BugReport.yml | 68 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FeatureRequest.yml | 26 +++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ 3 files changed, 99 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BugReport.yml create mode 100644 .github/ISSUE_TEMPLATE/FeatureRequest.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/BugReport.yml b/.github/ISSUE_TEMPLATE/BugReport.yml new file mode 100644 index 0000000..149ba59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BugReport.yml @@ -0,0 +1,68 @@ +name: Bug Report +description: File a bug report. +title: "[Bug]: " +labels: ["bug", "needs triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - 0.5 (Default) + - Nightly + default: 0 + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: textarea + id: logs + attributes: + label: Relevant debug log output + description: Please copy and paste any relevant debug log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: textarea + attributes: + label: Screenshots/Live demo link + description: Add some screenshots to help explain the problem. + validations: + required: false + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow the AsiprePress [Code of Conduct](https://github.com/aspirepress/AspireUpdate?tab=coc-ov-file). + options: + - label: I agree to follow the Code of Conduct. + required: true + diff --git a/.github/ISSUE_TEMPLATE/FeatureRequest.yml b/.github/ISSUE_TEMPLATE/FeatureRequest.yml new file mode 100644 index 0000000..36778dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FeatureRequest.yml @@ -0,0 +1,26 @@ +name: Feature Request +description: Suggest an idea for this project. +labels: ['enhancement'] +body: + - type: checkboxes + attributes: + label: 'I have checked the following:' + options: + - label: I've searched existing issues and found nothing related to my issue. + required: true + - type: markdown + attributes: + value: | + Suggest an idea for this project. + - type: textarea + attributes: + label: Describe the feature you want to add + description: A clear and concise description of the feature you want to be added. + validations: + required: true + - type: textarea + attributes: + label: Mockups or Images of the feature + description: Add some images to support your feature. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ef57f72 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Discussions & Support + url: https://aspirepress.org/slack/ + about: You can ask general questions or give feedback on the AspirePress community. From 9c00cfd548a239441d701af5e01230e317d99969 Mon Sep 17 00:00:00 2001 From: Alex Sirota Date: Sat, 2 Nov 2024 10:05:03 -0400 Subject: [PATCH 2/5] update GPLv2 license Signed-off-by: Alex Sirota --- readme.txt | 82 +++++++++++++++++++++++++++--------------------------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/readme.txt b/readme.txt index c20faae..a3d1917 100644 --- a/readme.txt +++ b/readme.txt @@ -1,41 +1,41 @@ -=== AspireUpdate === -Contributors: sarah-savage, namithj, asirota -Donate link: https://github.com/sponsors/aspirepress -Tags: -Requires at least: 5.3 -Tested up to: 6.7 -Stable tag: 0.5 -Requires PHP: 7.4 -License: GPL-3.0-or-later -License URI: https://www.gnu.org/licenses/gpl-3.0.html - -This plugin allows a WordPress user to automatically rewrite certain URLs and URL paths to a new URL. - -== Description == - -This plugin allows a WordPress user to automatically rewrite certain URLs and URL paths to a new URL. This is helpful because it allows for the rewriting of api.wordpress.org to some other repository that contains the plugins the user wants. - -The plugin supports multiple rewrites, and also supports rewriting the URL paths of the requests on a per-host basis. This improves the capacity of the plugin to adequately support newer or different repositories. -. - -== Frequently Asked Questions == - -= A question that someone might have = - -An answer to that question. - -= What about foo bar? = - -Answer to foo bar dilemma. - -== Screenshots == - -1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Screenshots are stored in the /assets directory. -2. This is the second screen shot - -== Changelog == - -= 0.5 = -* first stable version, connects to api.wordpress.org or an alternative AspireCloud repository - -== Upgrade Notice == +=== AspireUpdate === +Contributors: sarah-savage, namithj, asirota +Donate link: https://github.com/sponsors/aspirepress +Tags: +Requires at least: 5.3 +Tested up to: 6.7 +Stable tag: 0.5 +Requires PHP: 7.4 +License: GPLv2 +License URI: https://www.gnu.org/licenses/gpl-2.0.html + +This plugin allows a WordPress user to automatically rewrite certain URLs and URL paths to a new URL. + +== Description == + +This plugin allows a WordPress user to automatically rewrite certain URLs and URL paths to a new URL. This is helpful because it allows for the rewriting of api.wordpress.org to some other repository that contains the plugins the user wants. + +The plugin supports multiple rewrites, and also supports rewriting the URL paths of the requests on a per-host basis. This improves the capacity of the plugin to adequately support newer or different repositories. +. + +== Frequently Asked Questions == + += A question that someone might have = + +An answer to that question. + += What about foo bar? = + +Answer to foo bar dilemma. + +== Screenshots == + +1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Screenshots are stored in the /assets directory. +2. This is the second screen shot + +== Changelog == + += 0.5 = +* first stable version, connects to api.wordpress.org or an alternative AspireCloud repository + +== Upgrade Notice == From ab2395651053c480afa8ba77c110cd677aff8023 Mon Sep 17 00:00:00 2001 From: Alex Sirota Date: Thu, 7 Nov 2024 15:14:05 -0500 Subject: [PATCH 3/5] Update .github/ISSUE_TEMPLATE/BugReport.yml Co-authored-by: Colin Stewart <79332690+costdev@users.noreply.github.com> Signed-off-by: Alex Sirota --- .github/ISSUE_TEMPLATE/BugReport.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BugReport.yml b/.github/ISSUE_TEMPLATE/BugReport.yml index 149ba59..72323f8 100644 --- a/.github/ISSUE_TEMPLATE/BugReport.yml +++ b/.github/ISSUE_TEMPLATE/BugReport.yml @@ -61,7 +61,8 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow the AsiprePress [Code of Conduct](https://github.com/aspirepress/AspireUpdate?tab=coc-ov-file). + description: By submitting this issue, you agree to follow the AspirePress [Code of Conduct](https://github.com/aspirepress/AspireUpdate?tab=coc-ov-file). + options: - label: I agree to follow the Code of Conduct. required: true From 29dbb60259939b1202a235996184a9f67d1a4368 Mon Sep 17 00:00:00 2001 From: Alex Sirota Date: Thu, 7 Nov 2024 15:28:55 -0500 Subject: [PATCH 4/5] added lots of config to bug reports --- .github/ISSUE_TEMPLATE/BugReport.yml | 73 ++++++++++++++++++++++++++-- 1 file changed, 70 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BugReport.yml b/.github/ISSUE_TEMPLATE/BugReport.yml index 72323f8..0e8950c 100644 --- a/.github/ISSUE_TEMPLATE/BugReport.yml +++ b/.github/ISSUE_TEMPLATE/BugReport.yml @@ -20,21 +20,35 @@ body: attributes: label: What happened? description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! - value: "A bug happened!" + placeholder: Tell us what you are seeing or experiencing. + value: "A bug was witnessed!" validations: required: true - type: dropdown id: version attributes: label: Version - description: What version of our software are you running? + description: What version of AspireUpdate are you running? options: - 0.5 (Default) - Nightly default: 0 validations: required: true + + - type: dropdown + id: os + attributes: + label: 'OS' + description: 'The operating system you are running on (Linux, Windows, Mac, etc).' + options: + - Windows + - MacOS + - iOS + - Android + - Linux + - Other + - type: dropdown id: browsers attributes: @@ -45,6 +59,51 @@ body: - Chrome - Safari - Microsoft Edge + - Opera + - Other + + - type: input + id: wordpress + attributes: + label: 'WordPress' + description: 'The version of WordPress that your site uses.' + + - type: input + id: php + attributes: + label: 'PHP' + description: 'The version of PHP your site runs on.' + + - type: input + id: server + attributes: + label: 'Server' + description: 'The server your site runs on (apache, nginx, etc).' + + - type: input + id: database + attributes: + label: 'Database' + description: 'The database engine used by your site.' + + - type: input + id: theme + attributes: + label: 'Theme' + description: 'The currently active theme.' + + - type: input + id: must_use_plugins + attributes: + label: 'Must-Use Plugins' + description: 'A list of Must-Use Plugins.' + + - type: input + id: plugins + attributes: + label: 'Plugins' + description: 'A list of active plugins.' + - type: textarea id: logs attributes: @@ -57,6 +116,14 @@ body: description: Add some screenshots to help explain the problem. validations: required: false + + - type: textarea + id: additional_notes + attributes: + label: 'Additional Notes' + description: 'Any additional details worth mentioning.' + + - type: checkboxes id: terms attributes: From 0de914dd295a5e078f4c93acfab9fe2f6ec95dd4 Mon Sep 17 00:00:00 2001 From: Alex Sirota Date: Thu, 7 Nov 2024 16:05:53 -0500 Subject: [PATCH 5/5] added site health option --- .github/ISSUE_TEMPLATE/BugReport.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/BugReport.yml b/.github/ISSUE_TEMPLATE/BugReport.yml index 0e8950c..5b911d4 100644 --- a/.github/ISSUE_TEMPLATE/BugReport.yml +++ b/.github/ISSUE_TEMPLATE/BugReport.yml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! + Thanks for taking the time to fill out this bug report! You can use the Site Health option in your website to collect a lot of the data requested below. - type: input id: contact attributes: @@ -104,6 +104,13 @@ body: label: 'Plugins' description: 'A list of active plugins.' + - type: textarea + id: sitehealth + attributes: + label: WordPress Site Health Output (optional) + description: Please copy and paste a SiteHealth report with details of your WordPress configuration. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: textarea id: logs attributes: