Skip to content

Commit b59e103

Browse files
Thomas-BoiPanquesito7
Thomas-Boi
and
Panquesito7
authored
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>
1 parent d2254e4 commit b59e103

6 files changed

Lines changed: 93 additions & 22 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug/issue that you found in the SVGs, CSS files, etc.
4+
title: 'Bug Report: [NAME]'
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
### Bug
11+
*Short description of the bug that you found. Provide images/code if applicable.*
12+
13+
### How to replicate the bug
14+
*What should we do to replicate this bug.*
15+
16+
### Possible Fixes/Solutions
17+
*List any possible fixes/suggestions that you have in mind that could solve this issue.*

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature Request
3+
about: Requesting a new feature or changes to an existing feature
4+
title: 'Feature Request: [NAME]'
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
### Problem
11+
*Tell us about the current problem that you face that this feature might help you with.*
12+
13+
### Suggested Feature
14+
*Short description of the feature.*
15+
16+
### Why we should have this feature
17+
*List any extra benefits, other than solving your problem, that this feature will bring to the repo. If none, leave blank.*

‎.github/ISSUE_TEMPLATE/icon-request.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Icon request
2+
name: Icon Request
33
about: Requesting a new icon or changes to an existing icon
44
title: 'Icon request: [NAME]'
55
labels: 'request:icon'
@@ -8,8 +8,7 @@ assignees: ''
88
---
99

1010
### About the icon
11-
*Short description why you think this icon is matching in our project*
11+
*Short description of why you think this icon belongs in our project.*
12+
1213
### Links
13-
*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*
14-
### Preview
15-
*If available, provide some images of the icon you would like to be added*
14+
*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..).*

‎.github/PULL_REQUEST_TEMPLATE/new_feature.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1+
---
2+
name: New Feature
3+
about: Add a new feature to the repository.
4+
title: 'New Feature: [NAME]'
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
110
## This PR adds...
211

3-
*List your features here and their reasons for creation.*
12+
*List your features here and the benefits they bring.*
413

514
## Notes
615

7-
*List anything note-worthy here (potential issues, this needs merge to `master` before working, etc....).*
8-
16+
*List anything note-worthy here (potential issues, this needs to be merged to `master` before working, etc....).*
917
*Don't forget to link any issues that this PR will solved.*

‎.github/PULL_REQUEST_TEMPLATE/new_icon.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
1-
**Double check these details before you open a PR**
1+
---
2+
name: New Icon
3+
about: Add a new icon to the repo.
4+
title: 'New Icon: [NAME] (versions)'
5+
labels: 'feature:icon'
6+
assignees: ''
7+
8+
---
29

10+
**Double check these details before you open a PR**
11+
*Tick the checkboxes to ensure you've done everything*
312
- [] PR does not match another non-stale PR currently opened
413
- [] 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)
514
- [] 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 @@
918
Refer to the [`CONTRIBUTING.md`](https://github.com/devicons/devicon/blob/develop/CONTRIBUTING.md#contributing-to-devicon) for more details.
1019

1120

12-
**Link to official page to prove your SVG is correct and update to date**
13-
21+
**Link to the official page to prove your SVG is correct and up to date.**
1422
*Link goes here*

‎CONTRIBUTING.md‎

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ First of all, thanks for taking the time to contribute! This project can only gr
66
<h2>Table of Content</h2>
77
<ul>
88
<li><a href="#terms">Terms</a></li>
9+
<li><a href="#iconRequirements">What Icons Do We Accept?</a></li>
10+
<li><a href="#requestingIcon">Requesting An Icon</a></li>
911
<li><a href="#overview">Overview on Submitting Icon (start here if new)</a></li>
1012
<li><a href="#versionNaming">Naming Conventions</a></li>
1113
<li><a href="#SVGStandards">SVG Standards</a></li>
1214
<li><a href="#orgGuidelines">Organizational Guidelines</a></li>
1315
<li><a href="#updateDevicon">Updating the <code>devicon.json</code></a></li>
1416
<li><a href="#example">Example of Submitting An Icon</a></li>
15-
<li><a href="#requestingIcon">Requesting An Icon</a></li>
1617
<li><a href="#teams">Maintainer/Reviewer/Teams</a></li>
1718
<li><a href="#buildScript">The Build Script: how it works and its quirks</a></li>
1819
<li><a href="#discordServer">Discord server</a></li>
@@ -29,6 +30,37 @@ First of all, thanks for taking the time to contribute! This project can only gr
2930
<li>"icon" (lowercase) refers specficially to the font icon versions of the Icons.</li>
3031
</ol>
3132

33+
<hr>
34+
<h2 id='iconRequirements'>What Icons Do We Accept?</h2>
35+
<p>Devicon only accepts Icons of development languages and tools. </p>
36+
<p><b>Development</b> refers to programming or programming-related jobs.</p>
37+
<p><b>Tools</b> can be software, OS, services, etc. that helps with development. It must be specifically related to development (so software like Microsoft Word or Google Calendar won't be accepted since it's too general).</p>
38+
39+
<b>Special Cases (see <a href='https://github.com/devicons/devicon/discussions/353'>this discussion</a> for more details)</b>
40+
<ul>
41+
<li>Tech companies used to be accepted in the repository. However, we do not accept them anymore. Icons like Facebook, Twitter, etc., are kept due to backward compatibility. </li>
42+
<ul>
43+
<li>We still accept their icons if they represent a service and not the company itself.</li>
44+
<li>Ex. AWS is accepted since their names refer to their services. We will not accept Amazon since that's the parent company that includes non-tech related tools</li>
45+
</ul>
46+
<li>Related fields like graphic designs or game development. Since many "development" jobs require people to know related fields, some softwares will be accepted in Devicon even though they aren't strictly "development tools". </li>
47+
<ul>
48+
<li>ex. some Adobe products, game engines, CMS, etc... See <a href='https://github.com/devicons/devicon/pull/336'> for more details.</a></li>
49+
</ul>
50+
<li>General tools that are well known in the tech industries. Things like Trello, Slack, etc., are accepted under this category. Unfortunately, we won't accept Discord since its use is still too general. This will be treated on a case-by-case basis.</li>
51+
</ul>
52+
53+
54+
<hr>
55+
<h2 id='requestingIcon'>Requesting an Icon</h2>
56+
<p>To request an icon, you can create an issue in the repository. Please follow these simple guidelines:</p>
57+
<ul>
58+
<li>Search for other issues already requesting the icon</li>
59+
<li>If an issue doesn't exist, create an issue naming it "Icon request: <i>name-of-the-icon</i>". </li>
60+
<li>Please create separate issues for each icon</li>
61+
<li><b>Optional:</b> include links where the icon can be found</li>
62+
</ul>
63+
3264
<hr>
3365
<h2 id="overview">Overview on Submitting Icons</h2>
3466
<p>Here is what you have to do to submit your icons to the repo.</p>
@@ -294,16 +326,6 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web
294326
<li>For the rest of the steps, you can follow <a href="#overview">Overview on Submitting Icon</a></li>
295327
</ol>
296328

297-
<hr>
298-
<h2 id='requestingIcon'>Requesting an Icon</h2>
299-
<p>To request an icon, you can create an issue in the repo. Please follow these simple guidelines:</p>
300-
<ul>
301-
<li>Search for other issues already requesting the icon</li>
302-
<li>If an issue doesn't exist, create an issue naming it "Icon request: <i>name-of-the-icon</i>". </li>
303-
<li>Please create a separate issues for each icon</li>
304-
<li>Optional: include links where the icon can be found</li>
305-
</ul>
306-
307329
<hr>
308330
<h2 id='teams'>Maintainer/Reviewer/Teams</h2>
309331
<p>

0 commit comments

Comments
 (0)