Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve readability, consistency, and formatting #334

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ body:
value: |
## Thanks for taking the time to fill out this bug report!

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.
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.
- type: dropdown
attributes:
label: Which Framework?
description: Select all the framework that you are facing issues with.
label: Which framework are you using?
description: Select all the frameworks where you are experiencing issues.
multiple: true
options:
- "React"
Expand All @@ -28,19 +28,19 @@ body:
- type: textarea
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
description: Describe the issue and what you expected to happen.
placeholder: Tell us what you see!
- type: textarea
attributes:
label: Steps to reproduce
description: Please could you provide clearly ordered steps to reproduce the issue.
description: Please provide clearly ordered steps to reproduce the issue.
placeholder: |
1. Login to the System
2. Click the Menu Item
1. Log in to the system
2. Click the menu item
3. Submit
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Links? References? Any additional context about the issue you are encountering?
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ blank_issues_enabled: false
contact_links:
- name: Discussions
url: https://github.com/celo-org/celo-composer/discussions
about: General discussions about Celo Composer
- name: Check Docs
about: General discussions about Celo Composer.
- name: Documentation
url: https://docs.celo.org/
about: If you need help with your first steps of Celo Composer, check out the docs!
about: Need help getting started with Celo Composer? Check out the official docs!
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
name: Feature Request
description: File a feature request
description: Submit a feature request
title: "[Feature]: "
body:
- type: markdown
attributes:
value: |
## Thanks for taking the time to fill out this feature request!
## Thanks for taking the time to submit this feature request!

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.
We appreciate all ideas and suggestions. The more details you provide, the better we can understand and evaluate your request.
- type: textarea
attributes:
label: Tell us about your idea
label: Describe your idea
description: |
- Give as much detail as you can to help us understand the change you want to see.
- What is the expected outcome?
- Provide as much detail as possible to help us understand the change you’d like to see.
- What is the expected outcome or benefit?
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context.
Links? References? Any additional context that can help us understand your request.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
Loading