Create a general pull_request_template.md (#703)

* Create a general pull_request_template.md * Apply suggestions from code review Co-authored-by: David Leal <halfpacho@gmail.com> * Add line about base of PR in pr template * Update PR and Issue templates * Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Good idea Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Co-authored-by: David Leal <halfpacho@gmail.com> * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: David Leal <halfpacho@gmail.com>
2025-08-14 02:24:04 +02:00 · 2021-07-05 18:35:15 -07:00
parent b13b02d019
commit 3e90d55653
8 changed files with 100 additions and 48 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,10 +8,10 @@ assignees: ''
 ---

 ### Bug
-*Short description of the bug that you found. Provide images/code if applicable.*
+<!-- Short description of the bug that you found. Provide images/code if applicable. -->

 ### How to replicate the bug
-*What should we do to replicate this bug.*
+<!-- What should we do to replicate this bug. -->

 ### Possible Fixes/Solutions
-*List any possible fixes/suggestions that you have in mind that could solve this issue.*
+<!-- List any possible fixes/suggestions that you have in mind that could solve this issue. -->
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,10 +8,10 @@ assignees: ''
 ---

 ### Problem 
-*Tell us about the current problem that you face that this feature might help you with.*
+<!-- Tell us about the current problem that you face that this feature might help you with. -->

 ### Suggested Feature
-*Short description of the feature.*
+<!-- Short description of the feature. -->

 ### Why we should have this feature
-*List any extra benefits, other than solving your problem, that this feature will bring to the repo. If none, leave blank.*
+<!-- List any extra benefits, other than solving your problem, that this feature will bring to the repository. If none, leave blank. -->
--- a/.github/ISSUE_TEMPLATE/icon-request.md
+++ b/.github/ISSUE_TEMPLATE/icon-request.md
@@ -4,11 +4,10 @@ about: Requesting a new icon or changes to an existing icon
 title: 'Icon request: [NAME]'
 labels: 'request:icon'
 assignees: ''
-
 ---

 ### About the icon
-*Short description of why you think this icon belongs in our project.*
+<!-- Short description of why you think this icon belongs in our project. -->

 ### Links
-*Provide links to the icon's official website/repository. Anywhere that shows us what the technology is about and its official logo. If available, also provide some resources (SVG's) where the icon can be found (Font Awesome, Icomoon, etc..).*
+<!-- Provide links to the icon's official website/repository. Anywhere that shows us what the technology is about and its official logo. If available, also provide some resources where the icon/SVG can be found (Font Awesome, Icomoon, etc.).-->
--- a/.github/PULL_REQUEST_TEMPLATE/new_feature.md
+++ b/.github/PULL_REQUEST_TEMPLATE/new_feature.md
@@ -1,17 +0,0 @@
---
-name: New Feature
-about: Add a new feature to the repository.
-title: 'New Feature: [NAME]'
-labels: 'enhancement'
-assignees: ''
-
---
-
-## This PR adds...
-
-*List your features here and the benefits they bring.*
-
-## Notes
-
-*List anything note-worthy here (potential issues, this needs to be merged to `master` before working, etc....).*
-*Don't forget to link any issues that this PR will solved.*
--- a/.github/PULL_REQUEST_TEMPLATE/new_icon.md
+++ b/.github/PULL_REQUEST_TEMPLATE/new_icon.md
@@ -1,22 +0,0 @@
---
-name: New Icon
-about: Add a new icon to the repo.
-title: 'New Icon: [NAME] (versions)'
-labels: 'feature:icon'
-assignees: ''
-
---
-
-**Double check these details before you open a PR**
-*Tick the checkboxes to ensure you've done everything*
- [] 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>)* as seen [here](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#overview)
- [] Your icons are put in 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.md`](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#contributing-to-devicon) for more details.
-
-
-**Link to the official page to prove your SVG is correct and up to date.**
-*Link goes here*
--- a/.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md
+++ b/.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md
@@ -0,0 +1,24 @@
+---
+name: New Feature
+about: Add a new feature to the repository.
+title: 'New Feature: [NAME]'
+labels: 'enhancement'
+assignees: ''
+
+---
+<!-- If you are adding a new icon, 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: 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 `master` before working, etc.). -->
--- a/.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md
+++ b/.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md
@@ -0,0 +1,23 @@
+---
+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 -->
+- [] 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)
+- [] 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](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#contributing-to-devicon) guidelines for more details. -->
+
+## 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. -->
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -0,0 +1,45 @@
+---
+name: Pull Request Template
+about: Add a new icon or feature to the repo.
+title: 'New Icon/Feature: [NAME]'
+assignees: ''
+
+---
+# New Icon Section
+
+<!-- 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)
+- [] 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](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#contributing-to-devicon) guidelines for more details. -->
+
+## 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 icon, 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: 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 `master` before working, etc.). -->