Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue and PR templates #658

Merged
merged 14 commits into from
Jun 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/icon-request.md
Original file line number Diff line number Diff line change
@@ -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'
Expand All @@ -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 changes: 11 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE/new_feature.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE/new_icon.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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*
44 changes: 33 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ First of all, thanks for taking the time to contribute! This project can only gr
<h2>Table of Content</h2>
<ul>
<li><a href="#terms">Terms</a></li>
<li><a href="#iconRequirements">What Icons Do We Accept?</a></li>
<li><a href="#requestingIcon">Requesting An Icon</a></li>
<li><a href="#overview">Overview on Submitting Icon (start here if new)</a></li>
<li><a href="#versionNaming">Naming Conventions</a></li>
<li><a href="#SVGStandards">SVG Standards</a></li>
<li><a href="#orgGuidelines">Organizational Guidelines</a></li>
<li><a href="#updateDevicon">Updating the <code>devicon.json</code></a></li>
<li><a href="#example">Example of Submitting An Icon</a></li>
<li><a href="#requestingIcon">Requesting An Icon</a></li>
<li><a href="#teams">Maintainer/Reviewer/Teams</a></li>
<li><a href="#buildScript">The Build Script: how it works and its quirks</a></li>
<li><a href="#discordServer">Discord server</a></li>
Expand All @@ -29,6 +30,37 @@ First of all, thanks for taking the time to contribute! This project can only gr
<li>"icon" (lowercase) refers specficially to the font icon versions of the Icons.</li>
</ol>

<hr>
<h2 id='iconRequirements'>What Icons Do We Accept?</h2>
<p>Devicon only accepts Icons of development languages and tools. </p>
<p><b>Development</b> refers to programming or programming-related jobs.</p>
<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>

<b>Special Cases (see <a href='https://github.com/devicons/devicon/discussions/353'>this discussion</a> for more details)</b>
<ul>
<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>
<ul>
<li>We still accept their icons if they represent a service and not the company itself.</li>
<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>
</ul>
<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>
<ul>
<li>ex. some Adobe products, game engines, CMS, etc... See <a href='https://github.com/devicons/devicon/pull/336'> for more details.</a></li>
</ul>
<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>
</ul>


<hr>
<h2 id='requestingIcon'>Requesting an Icon</h2>
<p>To request an icon, you can create an issue in the repository. Please follow these simple guidelines:</p>
<ul>
<li>Search for other issues already requesting the icon</li>
<li>If an issue doesn't exist, create an issue naming it "Icon request: <i>name-of-the-icon</i>". </li>
<li>Please create separate issues for each icon</li>
<li><b>Optional:</b> include links where the icon can be found</li>
</ul>

<hr>
<h2 id="overview">Overview on Submitting Icons</h2>
<p>Here is what you have to do to submit your icons to the repo.</p>
Expand Down Expand Up @@ -294,16 +326,6 @@ As an example, let's assume you have created the SVGs for Redhat and Amazon Web
<li>For the rest of the steps, you can follow <a href="#overview">Overview on Submitting Icon</a></li>
</ol>

<hr>
<h2 id='requestingIcon'>Requesting an Icon</h2>
<p>To request an icon, you can create an issue in the repo. Please follow these simple guidelines:</p>
<ul>
<li>Search for other issues already requesting the icon</li>
<li>If an issue doesn't exist, create an issue naming it "Icon request: <i>name-of-the-icon</i>". </li>
<li>Please create a separate issues for each icon</li>
<li>Optional: include links where the icon can be found</li>
</ul>

<hr>
<h2 id='teams'>Maintainer/Reviewer/Teams</h2>
<p>
Expand Down