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: update bug_report.yml #602

Merged
merged 3 commits into from
May 26, 2023
Merged
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ body:
- type: checkboxes
id: questions
attributes:
label: Please review the checkboxes that are applicable.
options:
- label: This issue is directly related to React
required: true
39 changes: 24 additions & 15 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,38 @@
name: Feature request
description: Suggest an idea for this project
title: "[Suggestion]: <Context of the suggestion>"
description: Suggest a new feature or enhancement for the library
title: "[Feature Request]: <Context of the feature request>"
body:
- type: textarea
id: description
id: problem-description
attributes:
label: Is your feature request related to a problem? Please describe.
label: Describe the problem or use case
description: |
A clear and concise description of what the problem is.
Provide a detailed description of the problem or use case that the proposed feature aims to address.

Ex. I'm always frustrated when [...]
For example: "When using the Baklava in scenario X, I encountered issues with..."
validations:
required: true
- type: textarea
id: description
id: solution-description
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
label: Proposed solution
description: |
Describe your proposed solution or enhancement in detail.

Explain how the new feature would work and how it would address the problem or improve the Baklava.
- type: textarea
id: description
id: alternatives-description
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
label: Alternatives considered
description: |
If you have considered any alternative approaches or solutions, please describe them here.

Explain why the proposed solution is preferred over the alternatives.
- type: textarea
id: description
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
label: Additional technical context
description: |
Provide any additional technical context or considerations that may be relevant to the feature request.

Include code snippets, relevant documentation, or any other information that can help the development team understand and evaluate the request better.
44 changes: 22 additions & 22 deletions .github/ISSUE_TEMPLATE/new-component-definition.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ body:
id: rules
attributes:
label: Rules
description: Put some rules about how this component should behave and implemented
description: Put some rules about how this component should behave and be implemented
placeholder: |
* Rule 1
* Rule 2
Expand All @@ -32,26 +32,26 @@ body:
| --------------- | --------------- | --------------- |
| attr (`string`) | attr desc | - |
- type: textarea
id: slots
attributes:
label: Slots
value: |
| Name | Description | Default Content |
| --------------- | --------------- | --------------- |
| `default` slot | What to put | - |
id: slots
attributes:
label: Slots
value: |
| Name | Description | Default Content |
| --------------- | --------------- | --------------- |
| `default` slot | What to put | - |
- type: textarea
id: events
attributes:
label: Events
value: |
| Event | Description |
| --------------- | --------------- |
| `bl-{event-name}` | Event description |
id: events
attributes:
label: Events
value: |
| Event | Description |
| --------------- | --------------- |
| `bl-{event-name}` | Event description |
- type: textarea
id: css
attributes:
label: CSS Custom Properties
value: |
| Property | Description | Default Value |
| --------------- | --------------- | --------------- |
| `bl-name` | Property desc | - |
id: css
attributes:
label: CSS Custom Properties
value: |
| Property | Description | Default Value |
| --------------- | --------------- | --------------- |
| `--bl-name` | Property desc | - |