beenull/simple-icons
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Issue forms (#6303)

Browse source 
* create issue form for icon requests

* cleanup old issue template

* create issue form for icon updates

* create package and documentation forms

* fix: description strings

* remove "render" from textarea

* add additional comments section to icon request/update form

* fix: grammar

* fix: more grammar

* feat: default issue titles

* move contributing guidelines to top, make resources required

* fix contributing guidelines link

* remove unnecessary queustion from documentation form

* add description for website field

* trim trailing whitespace

* fix linting errors

* add examples to additional comments description

* simplify fields to specify issue type

* update examples in documentation description

* align icon update with icon request

* fix: grammar

* align package and documentation forms

* require "Kind of issue"

* clarify kind of issue description

* better grammar in kind of issue description

* allow issue authors to specify if they would like to contribute

* use dropdown in contributing field

* update form notice for duplicate issues

link searches open issues by default

* update contributing description and make field required

* add different contributing descriptions

* add placeholders

* change "Alexa rank" to "Popularity Metric"

* change "insufficient" to "too low"

* add backticks around hex color in placeholder

* reword license question

* convert popularity metric to textarea

* update all descriptions

* no more inline links

* fix links

* remove trailing whitespace

* proper newline

* proper newline 2

* capitalize options

* capitalize options

* add to additional comments description

* fix icon request resources description

* fix sentences structure

* consistent wording - "docs," not "documentation"

* remove contributing field from package form

* separate inputs for version information

* better wording for software input

* fix link formatting

* more link formatting

* update additional comments description

* align resources description across forms

* remove unnecessary questions from icon update description

* format

* fix icon request links

* add version to chrome example in placeholder

* change Simple Icons to Package in label

* consistent "None" across forms

* consistent "None" across forms

* consistent additional comments field

* improve wording in version description

* fix wording in icon request popularity metric description

* minor placeholder updates

* fix "this issue concerns..." label

* add improvement option to package form

* add performance option

* consistency

Co-authored-by: Eric Cornelissen <ericornelissen@gmail.com>
This commit is contained in:
Sachin Raja 2021-08-25 13:22:30 -07:00 committed by GitHub
parent 50553c9e97
commit 73f6483337
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 258 additions and 95 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
.github/ISSUE_TEMPLATE/documentation.md vendored
View file

@ -1,23 +0,0 @@
---
name: Documentation
about: Report problems and suggest ideas for the documentation
labels: docs
---
<!-- Before opening a new issue search for duplicate or closed issues -->
### Kind of issue <!-- Change the one that applies to `[x]` -->
- [ ] Improvement
- [ ] Mistake
- [ ] Other, namely:
### Description
<!--
Anything relevant, for example:
- A (perma)link to the documentation
- For improvements: Suggested for how to improve
- For mistakes: Suggested fixes
-->

47
.github/ISSUE_TEMPLATE/documentation.yml vendored Normal file
View file

@ -0,0 +1,47 @@
name: Documentation
description: Report problems and suggest ideas for the documentation
labels: [docs]
body:
- type: markdown
attributes:
value: >-
Before opening a new issue, make sure it isn't covered by an existing issue.
Please search for [issues with the `docs` label][docs-issues] (including
closed issues) before you continue.
[docs-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3Adocs+is%3Aopen
- type: dropdown
attributes:
label: Kind of Issue
description: >-
If your issue type is not here, select "other" and explain in the
"Description" field below.
options: [Improvement, Mistake, Other]
validations:
required: true
- type: textarea
attributes:
label: Description
description: |
Include as much detail as possible, for example:
- A (perma)link to the docs in question
- Suggestions for how to change the docs
placeholder: "Example: The documentation doesn't cover my use case of the NPM package..."
validations:
required: true
- type: dropdown
attributes:
label: Contributing
description: >-
This is an open source project and we welcome contributions. Do you want to
work on this issue?
options:
- "Yes"
- "No"
validations:
required: true

29
.github/ISSUE_TEMPLATE/icon_request.md vendored
View file

@ -1,29 +0,0 @@
---
name: Icon request
about: Request a new icon for Simple Icons
labels: new icon
---
<!--
We won't add non-brand icons or anything related to illegal services.
If in doubt, open an issue and we'll have a look.
Before opening a new issue please search for duplicate or closed
issues or PRs. If you find one for the brand your requesting then
leave a comment on it or add a reaction to the original post.
When requesting a new icon please provide the following information:
-->
**Brand Name:**
**Website:**
**Alexa rank:**
<!-- The Alexa rank can be retrieved at https://www.alexa.com/siteinfo/
Please see our contributing guidelines for more details on how we
assess a brand's popularity. -->
**Official resources for icon and color:**
<!-- for example media kits, brand guidelines, SVG files, etc. -->
<!-- For more details on our processes please see our contributing
guidelines, which can be found at
https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md -->

90
.github/ISSUE_TEMPLATE/icon_request.yml vendored Normal file
View file

@ -0,0 +1,90 @@
name: Icon request
description: Request a new icon for Simple Icons
title: "Request: "
labels: [new icon]
body:
- type: markdown
attributes:
value: >-
We won't add non-brand icons or anything related to illegal services. If in
doubt, open an issue and we'll have a look. For more details see the
[Contributing Guidelines].
Before opening a new issue, make sure it isn't covered by an existing issue.
Please search for [issues with the `new icon` label][new-icon-issues]
(including closed issues) before you continue. If you find one for the brand
you're requesting then leave a comment on it or add a reaction.
[contributing guidelines]: https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md
[new-icon-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3A%22new+icon%22+is%3Aopen
- type: input
attributes:
label: Brand Name
placeholder: "Example: Simple Icons"
validations:
required: true
- type: input
attributes:
label: Website
description: >-
For non-web brands you can add a relevant link. You can put "None" if you don't
think there's a website.
placeholder: "Example: https://simpleicons.org"
validations:
required: true
- type: textarea
attributes:
label: Popularity Metric
description: >-
Provide either an [Alexa rank] or the number of GitHub stars. If these are not
available or too low you can still open the issue. In this case, please
provide any information regarding the brand's popularity you think is
relevant.
[alexa rank]: https://www.alexa.com/siteinfo
placeholder: "Example: The Alexa rank is 249,089. See https://www.alexa.com/siteinfo/simpleicons.org"
validations:
required: true
- type: textarea
attributes:
label: Official Resources for Icon and Color
description: >-
Media kits, brand guidelines, SVG files, etc. You can set
this to "None" if you are unable to find any resources.
placeholder: |
Example:
svg: https://github.com/simple-icons/simple-icons/blob/develop/icons/simpleicons.svg
color: `#111111`, from the website header
validations:
required: true
- type: textarea
attributes:
label: Additional Comments
description: |
Is there anything else we should know about the brand? Remember that not everyone knows the brand as well as you do. For example:
- Are there multiple options for the logo and/or color?
- Is the icon released under a license?
- If you think the brand might not be accepted, why do you think it should be considered?
placeholder: "Example: There are two variants of this icon..."
- type: dropdown
attributes:
label: Contributing
description: >-
This is an open source project and we welcome contributions. Do you want to
add this icon?
options:
- "Yes"
- "No"
validations:
required: true

13
.github/ISSUE_TEMPLATE/icon_update.md vendored
View file

@ -1,13 +0,0 @@
---
name: Icon update
about: Help us improve by reporting outdated icons
labels: icon outdated
---
<!-- Before opening a new issue search for duplicate or closed issues -->
<!-- When reporting an update to an icon we need information such as: -->
**Brand Name:**
**Official resources for icon and color:**
<!-- for example media kits, brand guidelines, SVG files, ...) -->

57
.github/ISSUE_TEMPLATE/icon_update.yml vendored Normal file
View file

@ -0,0 +1,57 @@
name: Icon update
description: Help us improve by reporting outdated icons
title: "Update: "
labels: [icon outdated]
body:
- type: markdown
attributes:
value: >-
Before opening a new issue, make sure it isn't covered by an existing issue.
Please search for [issues with the `icon outdated` label][icon-outdated-issues]
(including closed issues) before you continue. If you find one for the brand
you're reporting then leave a comment on it or add a reaction.
[icon-outdated-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3A%22icon+outdated%22+is%3Aopen
- type: input
attributes:
label: Brand Name
placeholder: "Example: Simple Icons"
validations:
required: true
- type: textarea
attributes:
label: Official Resources for Icon and Color
description: >-
Media kits, brand guidelines, SVG files, etc. You can set
this to "None" if you are unable to find any resources.
placeholder: |
Example:
svg: https://github.com/simple-icons/simple-icons/blob/develop/icons/simpleicons.svg
color: `#111111`, from the website header
validations:
required: true
- type: textarea
attributes:
label: Additional Comments
description: |
Is there anything else we should know about the brand? Remember that not everyone knows the brand as well as you do. For example:
- Are there multiple options for the logo and/or color?
- Is the icon released under a license?
placeholder: "Example: There are two variants of this icon..."
- type: dropdown
attributes:
label: Contributing
description: >-
This is an open source project and we welcome contributions. Do you want to
update this icon?
options:
- "Yes"
- "No"
validations:
required: true

30
.github/ISSUE_TEMPLATE/package.md vendored
View file

@ -1,30 +0,0 @@
---
name: Packages
about: Report problems and suggest ideas for the packages
labels: package
---
<!-- Before opening a new issue search for duplicate or closed issues -->
### Kind of issue <!-- Change the one that applies to `[x]` -->
- [ ] Improvement
- [ ] Bug
- [ ] Other, namely:
### This issue concerns <!-- Change the one that applies to `[x]` -->
- [ ] The NPM Package
- [ ] The Packagist Package
### Description
<!--
Anything relevant, for example:
- For bugs: "Steps to reproduce" and "Expected behavior"
- For improvements: An example of a use case
- Package issues: Version information
- For JavaScript/NodeJS: $ node --version
- For PHP/Packagist: $ composer --version
- etc.
-->

64
.github/ISSUE_TEMPLATE/package.yml vendored Normal file
View file

@ -0,0 +1,64 @@
name: Packages
description: Report problems and suggest ideas for the packages
labels: [package]
body:
- type: markdown
attributes:
value: >-
Before opening a new issue, make sure it isn't covered by an existing issue.
Please search for [issues with the `package` label][package-issues] (including
closed issues) before you continue.
[package-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3Apackage+is%3Aopen
- type: dropdown
attributes:
label: Kind of Issue
description: >-
If your issue type is not here, select "other" and explain in the
"Description" field below.
options: [Bug, Feature, Performance, Other]
validations:
required: true
- type: dropdown
attributes:
label: This issue concerns the...
options: [NPM package, Packagist package]
multiple: true
validations:
required: true
- type: input
attributes:
label: Package Version
placeholder: "Example: 5.11.0"
validations:
required: true
- type: textarea
attributes:
label: Other Software
description: >-
The software that you are using the package with (Node.js & NPM, PHP & Packagist,
Browser(s), other) and their versions. You can put "None" if you are unsure.
placeholder: |
Example:
Node.js v16
Chrome 92.0.4515.159 (Official Build) (64-bit)
validations:
required: true
- type: textarea
attributes:
label: Description
description: |
Anything relevant, for example:
- For bugs: "Steps to reproduce" and "Expected behavior"
- For feature requests: An example of a use case
- For performance: An example where performance is poor
placeholder: "Example: The NPM package does not work for my use case..."
validations:
required: true