Skip to content

Commit

Permalink
Asirota/add issue template (#99)
Browse files Browse the repository at this point in the history
* adding ISSUE_TEMPLATE

helps new GitHub contributors file better bugs or feature requests

Signed-off-by: Alex Sirota <[email protected]>

* update GPLv2 license

Signed-off-by: Alex Sirota <[email protected]>

* Update .github/ISSUE_TEMPLATE/BugReport.yml

Co-authored-by: Colin Stewart <[email protected]>
Signed-off-by: Alex Sirota <[email protected]>

---------

Signed-off-by: Alex Sirota <[email protected]>
Co-authored-by: Colin Stewart <[email protected]>
  • Loading branch information
asirota and costdev authored Nov 7, 2024
1 parent 2d07067 commit a406e1f
Show file tree
Hide file tree
Showing 4 changed files with 141 additions and 41 deletions.
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/BugReport.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
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 protected]
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 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

26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/FeatureRequest.yml
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
82 changes: 41 additions & 41 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -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: GPLv2
License URI: https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

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 ==

0 comments on commit a406e1f

Please sign in to comment.