From faf44b7dfd0889276ddb2629ba3bd496c874cec0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aykut=20Sara=C3=A7?= Date: Fri, 26 May 2023 09:34:29 +0300 Subject: [PATCH 1/3] docs: update bug_report.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Aykut Saraç --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b0c4ad8b..8f33a990 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -57,6 +57,7 @@ body: - type: checkboxes id: questions attributes: + label: options: - label: This issue is directly related to React required: true From da9bde96e06c40ccef93a1b0a3842641406d815a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aykut=20Sara=C3=A7?= Date: Fri, 26 May 2023 09:43:05 +0300 Subject: [PATCH 2/3] docs: fix syntax issues --- .github/ISSUE_TEMPLATE/bug_report.yml | 3 +- .github/ISSUE_TEMPLATE/feature_request.yml | 39 +++++++++------- .../new-component-definition.yml | 44 +++++++++---------- 3 files changed, 47 insertions(+), 39 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8f33a990..897b4561 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -57,7 +57,6 @@ body: - type: checkboxes id: questions attributes: - label: + label: Please review the checkboxes that are applicable. options: - label: This issue is directly related to React - required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index b1ea8dfe..d5f05419 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,29 +1,38 @@ name: Feature request -description: Suggest an idea for this project -title: "[Suggestion]: " +description: Suggest a new feature or enhancement for the library +title: "[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 Web Component 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 Web Component. - 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. diff --git a/.github/ISSUE_TEMPLATE/new-component-definition.yml b/.github/ISSUE_TEMPLATE/new-component-definition.yml index fac67a3a..8637e61e 100644 --- a/.github/ISSUE_TEMPLATE/new-component-definition.yml +++ b/.github/ISSUE_TEMPLATE/new-component-definition.yml @@ -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 @@ -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 | - | From e08f221c9770f5b02b37be7e658be29d2a77aaaa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aykut=20Sara=C3=A7?= Date: Fri, 26 May 2023 09:44:07 +0300 Subject: [PATCH 3/3] docs: update wordings --- .github/ISSUE_TEMPLATE/feature_request.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index d5f05419..07eb33b4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -9,7 +9,7 @@ body: description: | Provide a detailed description of the problem or use case that the proposed feature aims to address. - For example: "When using the Web Component in scenario X, I encountered issues with..." + For example: "When using the Baklava in scenario X, I encountered issues with..." validations: required: true - type: textarea @@ -19,7 +19,7 @@ body: 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 Web Component. + Explain how the new feature would work and how it would address the problem or improve the Baklava. - type: textarea id: alternatives-description attributes: