mirror of
https://github.com/konpa/devicon.git
synced 2025-08-30 09:40:04 +02:00
Update issue and PR templates (#658)
* Update issue and PR templates * Added icon requirements to contributing * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/ISSUE_TEMPLATE/bug_report.md Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/ISSUE_TEMPLATE/feature_request.md Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/ISSUE_TEMPLATE/feature_request.md Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/ISSUE_TEMPLATE/feature_request.md Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/ISSUE_TEMPLATE/icon-request.md Co-authored-by: David Leal <halfpacho@gmail.com> * Apply suggestions from code review Co-authored-by: David Leal <halfpacho@gmail.com> * Apply suggestions from code review Co-authored-by: David Leal <halfpacho@gmail.com> * Update bug_report.md * Update .github/PULL_REQUEST_TEMPLATE/new_feature.md 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>
This commit is contained in:
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug/issue that you found in the SVGs, CSS files, etc.
|
||||
title: 'Bug Report: [NAME]'
|
||||
labels: 'bug'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
### Bug
|
||||
*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.*
|
||||
|
||||
### Possible Fixes/Solutions
|
||||
*List any possible fixes/suggestions that you have in mind that could solve this issue.*
|
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Requesting a new feature or changes to an existing feature
|
||||
title: 'Feature Request: [NAME]'
|
||||
labels: 'enhancement'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
### Problem
|
||||
*Tell us about the current problem that you face that this feature might help you with.*
|
||||
|
||||
### Suggested 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.*
|
9
.github/ISSUE_TEMPLATE/icon-request.md
vendored
9
.github/ISSUE_TEMPLATE/icon-request.md
vendored
@@ -1,5 +1,5 @@
|
||||
---
|
||||
name: Icon request
|
||||
name: Icon Request
|
||||
about: Requesting a new icon or changes to an existing icon
|
||||
title: 'Icon request: [NAME]'
|
||||
labels: 'request:icon'
|
||||
@@ -8,8 +8,7 @@ assignees: ''
|
||||
---
|
||||
|
||||
### About the icon
|
||||
*Short description why you think this icon is matching in our project*
|
||||
*Short description of why you think this icon belongs in our project.*
|
||||
|
||||
### Links
|
||||
*Provide helpful links which can be used to take a deeper look into the icon and provide, if available, some resources (svg's) where the icon can be found*
|
||||
### Preview
|
||||
*If available, provide some images of the icon you would like to be added*
|
||||
*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..).*
|
||||
|
14
.github/PULL_REQUEST_TEMPLATE/new_feature.md
vendored
14
.github/PULL_REQUEST_TEMPLATE/new_feature.md
vendored
@@ -1,9 +1,17 @@
|
||||
---
|
||||
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 their reasons for creation.*
|
||||
*List your features here and the benefits they bring.*
|
||||
|
||||
## Notes
|
||||
|
||||
*List anything note-worthy here (potential issues, this needs merge to `master` before working, etc....).*
|
||||
|
||||
*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.*
|
||||
|
14
.github/PULL_REQUEST_TEMPLATE/new_icon.md
vendored
14
.github/PULL_REQUEST_TEMPLATE/new_icon.md
vendored
@@ -1,5 +1,14 @@
|
||||
**Double check these details before you open a PR**
|
||||
---
|
||||
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)
|
||||
@@ -9,6 +18,5 @@
|
||||
Refer to the [`CONTRIBUTING.md`](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#contributing-to-devicon) for more details.
|
||||
|
||||
|
||||
**Link to official page to prove your SVG is correct and update to date**
|
||||
|
||||
**Link to the official page to prove your SVG is correct and up to date.**
|
||||
*Link goes here*
|
||||
|
Reference in New Issue
Block a user