Skip to content

Commit 81b1f28

Browse files
authored
Merge pull request #334 from sergeypanin1994/main
docs: improve readability, consistency, and formatting
2 parents 36c6794 + e2d2053 commit 81b1f28

7 files changed

Lines changed: 220 additions & 289 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ body:
77
value: |
88
## Thanks for taking the time to fill out this bug report!
99
10-
We're sorry that your experiencing an issue. So that we can help you efficiently, please fill in this form to the best of your ability. The more information that you can provide the easier we will be able to help you.
10+
We're sorry that you're experiencing an issue. To help us assist you efficiently, please fill out this form to the best of your ability. The more details you provide, the easier it will be for us to resolve the issue.
1111
- type: dropdown
1212
attributes:
13-
label: Which Framework?
14-
description: Select all the framework that you are facing issues with.
13+
label: Which framework are you using?
14+
description: Select all the frameworks where you are experiencing issues.
1515
multiple: true
1616
options:
1717
- "React"
@@ -28,19 +28,19 @@ body:
2828
- type: textarea
2929
attributes:
3030
label: What happened?
31-
description: Also tell us, what did you expect to happen?
31+
description: Describe the issue and what you expected to happen.
3232
placeholder: Tell us what you see!
3333
- type: textarea
3434
attributes:
3535
label: Steps to reproduce
36-
description: Please could you provide clearly ordered steps to reproduce the issue.
36+
description: Please provide clearly ordered steps to reproduce the issue.
3737
placeholder: |
38-
1. Login to the System
39-
2. Click the Menu Item
38+
1. Log in to the system
39+
2. Click the menu item
4040
3. Submit
4141
- type: textarea
4242
attributes:
4343
label: Anything else?
4444
description: |
45-
Links? References? Anything that will give us more context about the issue you are encountering!
45+
Links? References? Any additional context about the issue you are encountering?
4646
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Discussions
44
url: https://github.com/celo-org/celo-composer/discussions
5-
about: General discussions about Celo Composer
6-
- name: Check Docs
5+
about: General discussions about Celo Composer.
6+
- name: Documentation
77
url: https://docs.celo.org/
8-
about: If you need help with your first steps of Celo Composer, check out the docs!
8+
about: Need help getting started with Celo Composer? Check out the official docs!
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
name: Feature Request
2-
description: File a feature request
2+
description: Submit a feature request
33
title: "[Feature]: "
44
body:
55
- type: markdown
66
attributes:
77
value: |
8-
## Thanks for taking the time to fill out this feature request!
8+
## Thanks for taking the time to submit this feature request!
99
10-
We love to hear any and all ideas that you may have. It would be great to get as much detail from you as you wish to provide.
10+
We appreciate all ideas and suggestions. The more details you provide, the better we can understand and evaluate your request.
1111
- type: textarea
1212
attributes:
13-
label: Tell us about your idea
13+
label: Describe your idea
1414
description: |
15-
- Give as much detail as you can to help us understand the change you want to see.
16-
- What is the expected outcome?
15+
- Provide as much detail as possible to help us understand the change you’d like to see.
16+
- What is the expected outcome or benefit?
1717
- type: textarea
1818
attributes:
1919
label: Anything else?
2020
description: |
21-
Links? References? Anything that will give us more context.
21+
Links? References? Any additional context that can help us understand your request.
2222
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.

0 commit comments

Comments
 (0)