Skip to content

Commit

Permalink
Upgrade PR and Issue Templates (devicons#986)
Browse files Browse the repository at this point in the history
* 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 <halfpacho@gmail.com>

* Update .github/PULL_REQUEST_TEMPLATE/new_feature.md

Co-authored-by: David Leal <halfpacho@gmail.com>

Co-authored-by: David Leal <halfpacho@gmail.com>
  • Loading branch information
Thomas-Boi and Panquesito7 authored Dec 27, 2021
1 parent bff3575 commit 02eeada
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 82 deletions.
15 changes: 4 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/icon_request.yml
Original file line number Diff line number Diff line change
@@ -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]: <icon name>'
labels: ["request:icon"]
body:
- type: input
Expand Down
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Double check these details before you open a PR

<!-- Tick the checkboxes to ensure you've done everything correctly -->
- [ ] PR does not match another non-stale PR currently opened

## Features
<!-- List your features here and the benefits they bring. Include images/codes as appropriate -->

**This PR closes NONE**
<!-- List issues that this PR would close above. Ex: This PR closes #1, #2, #3. -->

## Notes
<!-- List anything note-worthy here (potential issues, this needs to be merged to `master` before working, etc.). -->
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
---
name: New Icon
about: Add a new icon to the repository.
title: 'new icon: [NAME] (versions)'
labels: 'feature:icon'
assignees: ''

---
<!-- If you are adding a new icon, follow the steps listed here, and delete the **New Feature** section below. -->
## Double check these details before you open a PR

<!-- Tick the checkboxes to ensure you've done everything correctly -->
Expand All @@ -19,5 +10,8 @@ assignees: ''

<!-- Refer to the [contributing](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#contributing-to-devicon) guidelines for more details. -->

**This PR closes NONE**
<!-- List issues that this PR would close above. Ex: This PR closes #1, #2, #3. -->

## Link to prove your SVG is correct and up-to-date.
<!-- Link to an official page/wiki goes here. Anything that proves your SVGs are the correct ones. -->
24 changes: 0 additions & 24 deletions .github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md

This file was deleted.

41 changes: 4 additions & 37 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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`

<!-- If you are adding a new icon, follow the steps listed here, and delete the **New feature** section below. -->

## Double check these details before you open a PR

<!-- Tick the checkboxes to ensure you've done everything correctly -->
- [ ] PR does not match another non-stale PR currently opened
- [ ] PR name matches the format *new icon: <i>Icon name</i> (<i>versions separated by comma</i>)*. 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-)

<!-- Refer to the contributing guidelines for more details https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#contributing-to-devicon -->

## Link to prove your SVG is correct and up-to-date

<!-- Link to an official page/wiki goes here. Anything that proves your SVGs are the correct ones. -->

---
# **New feature section**

<!-- If you are adding a new feature, follow the steps listed here, and delete the **New icon** section above. -->

## Double check these details before you open a PR

<!-- Tick the checkboxes to ensure you've done everything correctly -->
- [ ] 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

<!-- List your features here and the benefits they bring. -->

## Notes

<!-- List anything note-worthy here (potential issues, this needs to be merged to `develop` before working, etc.). -->
### 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`.

0 comments on commit 02eeada

Please sign in to comment.