Skip to content

Commit 9d07fed

Browse files
Kyle-YeKyle-Ye
authored
[UX] Add Support Section Text and GitHub issue templates (#52)
* [Internal] Add GitHub issue and PR templates * [UX] Update SupportSection
1 parent eea8716 commit 9d07fed

10 files changed

+317
-47
lines changed

‎.github/ISSUE_TEMPLATE/BUG_REPORT.yml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug Report
2+
description: Something isn't working as expected
3+
labels: [Bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for your interest on Forumate!
9+
10+
Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist
11+
- type: textarea
12+
attributes:
13+
label: Description
14+
description: |
15+
A short description of the incorrect behavior.
16+
17+
If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
18+
validations:
19+
required: true
20+
- type: checkboxes
21+
attributes:
22+
label: Checklist
23+
options:
24+
- label: If possible, I've reproduced the issue using the latest version on App Store or TestFlight.
25+
required: false
26+
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/Kyle-Ye/Forumate/issues).
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Expected Behavior
31+
description: Describe what you expected to happen.
32+
validations:
33+
required: false
34+
- type: textarea
35+
attributes:
36+
label: Actual behavior
37+
description: Describe or copy/paste the behavior you observe.
38+
validations:
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Steps To Reproduce
43+
description: |
44+
Explanation of how to reproduce the incorrect behavior.
45+
This may include a screen recording and some text description to demonstrate your input operation.
46+
placeholder: |
47+
1. In my iPhone 13 or iPad mini 8, I open Forumate and enter Swift Forum.
48+
49+
2. With this input...
50+
51+
3. See error...
52+
validations:
53+
required: false
54+
- type: input
55+
attributes:
56+
label: Forumate Version Information
57+
description: The Forumate App version and OS version used to reproduce this issue. You can copy it from the bottom of Setting Tab.
58+
placeholder: "'Forumate Version 0.5.2 build 76 · macOS 14.0.0' for example, or a commit hash"

‎.github/ISSUE_TEMPLATE/FEATURE_SUGGESTION.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Feature Suggestion
2+
description: A suggestion for some new feature
3+
labels: [Feat]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for your interest on Forumate!
9+
10+
Before you submit your issue, please replace each text area below with information about your proposed feature.
11+
- type: input
12+
attributes:
13+
label: Feature Name
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Description
19+
description: |
20+
A description of your proposed feature.
21+
22+
Sample text to show what's missing, or what new capabilities will be possible, are very helpful! Provide links to existing issues or external references/discussions, if appropriate.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Motivation
28+
description: A description of the use-case this proposal is trying to serve.
29+
validations:
30+
required: false
31+
- type: textarea
32+
attributes:
33+
label: Importance
34+
description: |
35+
A description of the importance of this change.
36+
37+
Does this feature unlock entirely new use-cases or audience? Or is it possible to achieve the same functionality with existing functionality and this change would improve the user experience?
38+
validations:
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Alternatives Considered
43+
description: If you considered alternative approaches for this feature, please include them here.
44+
validations:
45+
required: false

‎.github/ISSUE_TEMPLATE/NEW_ICON.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Contribute new App Icon
2+
description: Informatino about the app icon you suggest
3+
labels: [Contribution]
4+
body
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for your interest on Forumate!
9+
10+
Before you submit your issue, please complete each text area below with the relevant details, and complete the steps in the checklist.
11+
12+
You will get a code to activate Pro feature of Forumate if your contribution is accepted.
13+
- type: input
14+
attributes:
15+
label: Link
16+
description: |
17+
Link to the public Figma or Sketch design file of the app icon.
18+
19+
You can use the existing resource in Forumate-Icon.md as template.
20+
21+
Your design file must include ALL Supported platforms of the active deployment branch.
22+
placeholder: "'https://example.com' for example"
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Description
28+
description: |
29+
A short description of the app icon.
30+
validations:
31+
required: true
32+
- type: checkboxes
33+
attributes:
34+
label: Checklist
35+
options:
36+
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/Kyle-Ye/Forumate/issues).
37+
required: true
38+
- label: You have confirmed that you have all copyrights of the posted design files and agree to grant all reasonable use within this App.
39+
required: true

‎.github/ISSUE_TEMPLATE/RECOMMEND_FORUM.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Suggest new Recommend Forum item
2+
description: Informatino about the item you suggest
3+
labels: [Contribution]
4+
body
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for your interest on Forumate!
9+
10+
Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist
11+
- type: input
12+
attributes:
13+
label: Link
14+
description: The new recommend forum item you suggest to add
15+
placeholder: "'https://example.com' for example"
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Description
21+
description: |
22+
A short description of the forum. And why you'd like to suggest it as a build-in recommend forum.
23+
validations:
24+
required: true
25+
- type: checkboxes
26+
attributes:
27+
label: Checklist
28+
options:
29+
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/Kyle-Ye/Forumate/issues).
30+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Forum Topic on Discourse Forum
5+
url: https://meta.discourse.org/t/forumate-native-discourse-client-for-ios
6+
about: Ask and answer general questions about Forumate
7+
- name: Join Forumate Discord Server
8+
url: https://discord.gg/ZHq5PzbGmE
9+
about: Discuss detail about Forumate

‎.github/pull_request_template.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Bug/issue #, if applicable:
2+
3+
## Summary
4+
5+
_Provide a description of what your PR addresses, explaining the expected user experience.
6+
Also, provide an overview of your implementation._
7+
8+
## Dependencies
9+
10+
_Describe any dependencies this PR might have, such as an associated branch in another repository._
11+
12+
## Testing
13+
14+
_Describe how a reviewer can test the functionality of your PR. Provide test content to test with if
15+
applicable._
16+
17+
Steps:
18+
1. _Provide setup instructions._
19+
2. _Explain in detail how the functionality can be tested._
20+
21+
## Checklist
22+
23+
Make sure you check off the following items. If they cannot be completed, provide a reason.
24+
25+
- [ ] Build all supported OS successfully
26+
- [ ] Updated README and documentation if necessary

0 commit comments

Comments
 (0)