From 3332e27fd3f5bf648d1791e05bd9982c7ff40f5e Mon Sep 17 00:00:00 2001 From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com> Date: Mon, 27 Dec 2021 12:24:44 -0800 Subject: [PATCH] Upgrade PR and Issue Templates (#986) * Update issue templates * Add pr templates * Update templates * Update pr templates * Update default pr template * Clarify pr closing statement * Apply suggestions from code review Co-authored-by: David Leal * Update .github/PULL_REQUEST_TEMPLATE/new_feature.md Co-authored-by: David Leal Co-authored-by: David Leal --- .github/ISSUE_TEMPLATE/feature_request.yml | 15 ++----- .github/ISSUE_TEMPLATE/icon_request.yml | 2 +- .github/PULL_REQUEST_TEMPLATE/new_feature.md | 13 ++++++ .../PULL_REQUEST_TEMPLATE/new_icon.md | 12 ++---- .../PULL_REQUEST_TEMPLATE/new_feature.md | 24 ----------- .github/pull_request_template.md | 41 ++----------------- 6 files changed, 25 insertions(+), 82 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/new_feature.md rename .github/{drafts => }/PULL_REQUEST_TEMPLATE/new_icon.md (82%) delete mode 100644 .github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index a637b86e..d0815fbe 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -7,23 +7,16 @@ body: id: currentproblem attributes: label: Problem - description: Tell us about the current problem that you face that this feature might help you with. + description: Tell us about the problem. validations: required: true - type: textarea - id: suggestedfeat + id: possiblesolution attributes: - label: Suggested feature - description: Tell us about the feature that might solve the above problem. + label: Possible Solution + description: If you have an idea, please tell us what might solve the above problem. validations: required: true - - type: textarea - id: why - attributes: - label: Why should we have this feature? - description: List any extra benefits, other than solving your problem, that this feature will bring to the repository. If none, leave blank. - validations: - required: false - type: textarea id: extrainformation attributes: diff --git a/.github/ISSUE_TEMPLATE/icon_request.yml b/.github/ISSUE_TEMPLATE/icon_request.yml index 04e3a29f..32637c14 100644 --- a/.github/ISSUE_TEMPLATE/icon_request.yml +++ b/.github/ISSUE_TEMPLATE/icon_request.yml @@ -1,6 +1,6 @@ name: Icon Request description: Requesting a new icon or changes to an existing icon -title: 'Icon request: [NAME]' +title: '[ICON REQUEST]: ' labels: ["request:icon"] body: - type: input diff --git a/.github/PULL_REQUEST_TEMPLATE/new_feature.md b/.github/PULL_REQUEST_TEMPLATE/new_feature.md new file mode 100644 index 00000000..9df58fd5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/new_feature.md @@ -0,0 +1,13 @@ +## Double check these details before you open a PR + + +- [ ] PR does not match another non-stale PR currently opened + +## Features + + +**This PR closes NONE** + + +## Notes + diff --git a/.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md b/.github/PULL_REQUEST_TEMPLATE/new_icon.md similarity index 82% rename from .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md rename to .github/PULL_REQUEST_TEMPLATE/new_icon.md index 57f046f7..58e458ef 100644 --- a/.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md +++ b/.github/PULL_REQUEST_TEMPLATE/new_icon.md @@ -1,12 +1,3 @@ ---- -name: New Icon -about: Add a new icon to the repository. -title: 'new icon: [NAME] (versions)' -labels: 'feature:icon' -assignees: '' - ---- - ## Double check these details before you open a PR @@ -19,5 +10,8 @@ assignees: '' +**This PR closes NONE** + + ## Link to prove your SVG is correct and up-to-date. diff --git a/.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md b/.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md deleted file mode 100644 index 2dc712b2..00000000 --- a/.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: New Feature -about: Add a new feature to the repository. -title: 'New Feature: [NAME]' -labels: 'enhancement' -assignees: '' - ---- - - -## Double check these details before you open a PR** - - -- [] PR does not match another non-stale PR currently opened -- [] PR name matches the format *New Feature: brief description of feature* - - -## This PR adds/fixes... - - - -## Notes - - diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b7118818..99a2cb90 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,38 +1,5 @@ -# **New icon section** +### Adding a New Icon? +- Add `?quick_pull=1&template=new_icon.md` to the end of your current URL and press `Enter` - - -## Double check these details before you open a PR - - -- [ ] PR does not match another non-stale PR currently opened -- [ ] PR name matches the format *new icon: Icon name (versions separated by comma)*. More details [here](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#overview) -- [ ] The PR's base is the `develop` branch. -- [ ] Your icons are inside a folder as seen [here](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#organizational-guidelines) -- [ ] SVG matches the standards laid out [here](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#svgStandards) -- [ ] A new object is added in the `devicon.json` file as seen [here](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#-updating-the-deviconjson-) - - - -## Link to prove your SVG is correct and up-to-date - - - ---- -# **New feature section** - - - -## Double check these details before you open a PR - - -- [ ] PR does not match another non-stale PR currently opened -- [ ] PR name matches the format *New Feature: a brief description of feature* - -## This PR adds/fixes - - - -## Notes - - +### Adding a New Feature or fixing a bug? +- Add `?quick_pull=1&template=new_feature.md` to the end of your current URL and press `Enter`. \ No newline at end of file