simple-icons/.github/ISSUE_TEMPLATE/documentation.yml
Sachin Raja 73f6483337
Issue forms (#6303)
* 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>
2021-08-25 22:22:30 +02:00

48 lines
1.4 KiB
YAML

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