From 864205da1ddb421660048ebb66e1f2e36fc8e8c7 Mon Sep 17 00:00:00 2001 From: Lucas Arcoverde Date: Wed, 17 Apr 2024 11:53:04 -0300 Subject: [PATCH 1/3] chore: add Proposal issue template --- .github/ISSUE_TEMPLATE/proposal.yml | 33 +++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/proposal.yml diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml new file mode 100644 index 0000000000..c2df0dd86a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal.yml @@ -0,0 +1,33 @@ +name: Proposal +description: Report a problem with Shoreline +labels: ['proposal', 'status: pending'] +body: + - type: markdown + attributes: + value: Hello! Use this template if you have designed a solution and want to share it with the community. If this doesn't look right, choose another template. + - type: textarea + id: problem + attributes: + label: The problem + description: Provide a clear and concise description of what the problem this proposal is trying to solve. (For example, I find it frustrating when...). Be sure to attach screenshots or videos to illustrate the problem. If this proposal is related to an existing issue, mention it here. + validations: + required: true + - type: textarea + id: solution + attributes: + label: The solution + description: Provide sample content, references, or audits of solutions solving the same problem in other applications/websites/projects. + validations: + required: true + - type: textarea + id: usage-examples + attributes: + label: Usage examples + description: If you are proposing a component or an icon, provide examples of how they would be used. You can use images or links with a small description. + - type: textarea + id: references + attributes: + label: References + description: List any content, references, or benchmarks you used for this proposal. + validations: + required: true From f63fd23732fccc6fcae4b6a5ac41891143b3544d Mon Sep 17 00:00:00 2001 From: Lucas Arcoverde Date: Wed, 17 Apr 2024 12:18:48 -0300 Subject: [PATCH 2/3] chore: improve proposal issue template --- .github/ISSUE_TEMPLATE/proposal.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml index c2df0dd86a..749762c687 100644 --- a/.github/ISSUE_TEMPLATE/proposal.yml +++ b/.github/ISSUE_TEMPLATE/proposal.yml @@ -1,5 +1,5 @@ name: Proposal -description: Report a problem with Shoreline +description: Propose an idea for this project. labels: ['proposal', 'status: pending'] body: - type: markdown @@ -16,7 +16,7 @@ body: id: solution attributes: label: The solution - description: Provide sample content, references, or audits of solutions solving the same problem in other applications/websites/projects. + description: Provide sample content, references, or audits of solutions solving the same problem in other applications/websites/projects. You can use one of our templates, [Component figma template](), [Component API template](), or [Icon figma template](). validations: required: true - type: textarea @@ -24,6 +24,11 @@ body: attributes: label: Usage examples description: If you are proposing a component or an icon, provide examples of how they would be used. You can use images or links with a small description. + - type: textarea + id: dependencies + attributes: + label: Dependencies + description: If your proposal is a dependency of or depends on another component, explain here how they interact and if there is any possible impact. - type: textarea id: references attributes: From 62e0de058c43eba6c8b6ae07ab49c05117005218 Mon Sep 17 00:00:00 2001 From: Lucas Arcoverde Date: Thu, 18 Apr 2024 10:24:44 -0300 Subject: [PATCH 3/3] chore: accept pr suggestions --- .github/ISSUE_TEMPLATE/proposal.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml index 749762c687..d9f776b0d9 100644 --- a/.github/ISSUE_TEMPLATE/proposal.yml +++ b/.github/ISSUE_TEMPLATE/proposal.yml @@ -8,15 +8,15 @@ body: - type: textarea id: problem attributes: - label: The problem - description: Provide a clear and concise description of what the problem this proposal is trying to solve. (For example, I find it frustrating when...). Be sure to attach screenshots or videos to illustrate the problem. If this proposal is related to an existing issue, mention it here. + label: Problem + description: Provide a clear and concise description of the problem this proposal is trying to solve. Include data from previous research, screenshots or videos to illustrate the problem. If this proposal is related to an existing issue, mention it here. validations: required: true - type: textarea id: solution attributes: - label: The solution - description: Provide sample content, references, or audits of solutions solving the same problem in other applications/websites/projects. You can use one of our templates, [Component figma template](), [Component API template](), or [Icon figma template](). + label: Solution + description: Provide the links, for example from a Figma file or a CodeSandbox, or code snippets that apply to your proposal. You can use one of our templates, [Component figma template](), [Component API template](), or [Icon figma template](). validations: required: true - type: textarea