Skip to content

Commit b452a2c

Browse files
authored
Add Issue Forms (#19011)
Issue Forms are now supported on the desktop and mobile versions of GitHub, and the mobile application links to the website to allow users fill the form Files have a numeric prefix to sort templates by priority, with icon requests at the top A special configuration is used to redirect users to the website when the issue is related to the Pro License. License related issues should not be addressed on a publicly accessible repository, because sensitive information (like email address) are necessary Ref: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
1 parent 2360bd5 commit b452a2c

File tree

7 files changed

+247
-0
lines changed

7 files changed

+247
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Icon request
2+
description: Suggest an icon to be included in Font Awesome
3+
labels: ["new icon"]
4+
title: "Icon request: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to request a new icon!
10+
- type: textarea
11+
id: use-case
12+
attributes:
13+
label: Use case
14+
description: Describe how this icon could be used.
15+
- type: textarea
16+
id: example
17+
attributes:
18+
label: Example image
19+
description: Insert the example image here if necessary. A good example is a single color image which plays well at small sizes (16px)
20+
- type: checkboxes
21+
id: icon-request-checklist
22+
attributes:
23+
label: Icon request checklist
24+
options:
25+
- label: 'The title starts with "Icon request: " and is followed by the requested icon name'
26+
required: true
27+
- label: 'This icon does not represent a brand'
28+
required: true
29+
- label: 'This is a single icon or matched pair (Ex: `lock` / `unlock`)'
30+
required: true
31+
- label: The request is for a concrete object, or I've included an example image
32+
required: true
33+
- label: 'I have [searched for existing issues](https://github.com/FortAwesome/Font-Awesome/issues) and to the best of my knowledge this is not a duplicate'
34+
required: true
35+
- label: 'I have [understood how requests work](https://fontawesome.com/community/leaderboard/new#faqs)'
36+
required: true
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Brand request
2+
description: Suggest a brand to be included in Font Awesome
3+
labels: ["brand icon"]
4+
title: "Brand request: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to request a new brand!
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Description
14+
description: Please enter a brief description of this brand and why it is important to have it in the core of Font Awesome
15+
- type: input
16+
id: official-website
17+
attributes:
18+
label: Official website
19+
description: Please provide the official website of this brand. The website must be in production and reachable from the public internet
20+
validations:
21+
required: true
22+
- type: input
23+
attributes:
24+
label: Brand guidelines
25+
description: "Link to brand guidelines, if available (e.g.: https://about.twitter.com/en/who-we-are/brand-toolkit)"
26+
- type: checkboxes
27+
id: icon-request-checklist
28+
attributes:
29+
label: Icon request checklist
30+
options:
31+
- label: 'The title starts with "Brand request: ", is followed by the requested brand name'
32+
required: true
33+
- label: 'I have [searched for existing issues](https://github.com/FortAwesome/Font-Awesome/issues) and to the best of my knowledge this is not a duplicate'
34+
required: true
35+
- label: 'I have [understood how requests work](https://fontawesome.com/community/leaderboard/brands#faqs)'
36+
required: true
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Bug report (Web - CSS - JS)
2+
description: Report a bug which occurs in a web application
3+
title: "Bug: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill up this bug report!
10+
11+
There are a lot of different ways of using Font Awesome. In order to help us
12+
debugging, please provide as much information as you can.
13+
14+
A reduced reproducible test case would definitely help the process.
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Bug description
19+
description: What happened? What are you seeing? How did you arrive here?
20+
validations:
21+
required: true
22+
- type: input
23+
id: reproducible-test-case
24+
attributes:
25+
label: Reproducible test case
26+
description: Provide a URL to a reproducible use case. Use codepen.io, jsfiddle.net, jsbin.com, codesandbox.io, or whatever.
27+
- type: textarea
28+
id: screenshots
29+
attributes:
30+
label: Screenshots
31+
description: Add screenshots to help explain your problem
32+
- type: input
33+
id: version
34+
attributes:
35+
label: Font Awesome version
36+
description: Provide the version of Font Awesome affected by this bug
37+
placeholder: v6.0.0
38+
validations:
39+
required: true
40+
- type: dropdown
41+
id: serving
42+
attributes:
43+
label: Serving
44+
multiple: true
45+
options:
46+
- Kit
47+
- Font Awesome CDN
48+
- Self-hosted
49+
- Other (as specified in the bug description)
50+
validations:
51+
required: true
52+
- type: dropdown
53+
id: implementation
54+
attributes:
55+
label: Implementation
56+
multiple: true
57+
options:
58+
- CSS
59+
- SVG+JS
60+
- SVG Sprites
61+
- Other (as specified in the bug description)
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: browser-operating-system
66+
attributes:
67+
label: Browser and Operating System
68+
description: Provide information about the browser and operating system affected by this bug. [List of supported browsers](https://fontawesome.com/v6/docs/web/dig-deeper/browser-support)
69+
placeholder: |
70+
- Chrome 94 on Windows 10
71+
- Firefox 92 on macOS
72+
validations:
73+
required: true
74+
- type: checkboxes
75+
id: web-bug-report-checklist
76+
attributes:
77+
label: Web bug report checklist
78+
options:
79+
- label: 'I have included a test case because my odds go _way_ up that the team can fix this when I do'
80+
- label: 'I have [searched for existing issues](https://github.com/FortAwesome/Font-Awesome/issues) and to the best of my knowledge this is not a duplicate'
81+
required: true
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Bug report (Desktop / Native / Other)
2+
description: Report a bug which occurs outside of a web application
3+
title: "Bug: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill up this bug report!
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Bug description
14+
description: What happened? What are you seeing? How did you arrive here?
15+
validations:
16+
required: true
17+
- type: input
18+
id: version
19+
attributes:
20+
label: Font Awesome version
21+
description: Provide the version of Font Awesome affected by this bug
22+
placeholder: v6.0.0
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: application-operating-system
27+
attributes:
28+
label: Application and Operating System
29+
description: Provide information about the application and operating system affected by this bug
30+
placeholder: |
31+
- GIMP on Windows 10
32+
- Adobe Photoshop on macOS
33+
validations:
34+
required: true
35+
- type: checkboxes
36+
id: web-bug-report-checklist
37+
attributes:
38+
label: Web bug report checklist
39+
options:
40+
- label: 'I have included a test case because my odds go _way_ up that the team can fix this when I do'
41+
- label: 'I have [searched for existing issues](https://github.com/FortAwesome/Font-Awesome/issues) and to the best of my knowledge this is not a duplicate'
42+
required: true
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Feature request
2+
description: Suggest an idea for Font Awesome
3+
title: "Feature request: "
4+
labels: ['feature']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thanks for taking the time to request a new feature!
9+
- type: textarea
10+
id: use-case
11+
attributes:
12+
label: Is your feature request related to a problem?
13+
description: A clear and concise description of what the problem is
14+
placeholder: I'm always frustrated when...
15+
- type: textarea
16+
id: feature
17+
attributes:
18+
label: Feature description
19+
description: A clear and concise description of what you want to happen
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: alternatives
24+
attributes:
25+
label: Alternatives
26+
description: A clear and concise description of any alternative solutions or features you've considered.
27+
- type: textarea
28+
id: additional-context
29+
attributes:
30+
label: Additional context
31+
description: Add any other context or screenshots about the feature request here
32+
- type: checkboxes
33+
id: feature-request-checklist
34+
attributes:
35+
label: Feature request checklist
36+
options:
37+
- label: 'The title starts with "Feature request: " and is followed by the requested feature description'
38+
required: true
39+
- label: 'This is a single feature'
40+
required: true
41+
- label: 'I have [searched for existing issues](https://github.com/FortAwesome/Font-Awesome/issues) and to the best of my knowledge this is not a duplicate'
42+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Pro License Issue
3+
url: https://fontawesome.com/#footer
4+
about: Click on the "Support" link in the footer

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<!--- WARNING Pull Requests made to this repository cannot be merged -->
2+
3+
I understand that:
4+
5+
- [ ] I'm submitting this PR for reference only. It shows an example of what I'd like to see changed but
6+
I understand that it will not be merged and I will not be listed as a contributor on this project.

0 commit comments

Comments
 (0)